Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

OpenTok.VideoCapturer.VideoDevice

Defines a video device (such as a camera). More...

Inherits IDisposable.

Public Member Functions

IList< VideoFormatListFormats ()
 Returns a list of video formats available for the device. More...
VideoCapturer CreateVideoCapturer (VideoFormat format)
 Creates a video capturer that uses the provided video format. More...
VideoCapturer CreateVideoCapturer (int width, int height, int fps=30)
 Creates a video capturer that uses the provided width, height, and frame rate. The video capturer will use the closest available settings. More...
VideoCapturer CreateVideoCapturer (Resolution resolution=Resolution.Medium, FrameRate frameRate=FrameRate.Fps30)
 Creates a video capturer that uses the provided resolution and frame rate. The video capturer will use the closest available settings. More...
void Dispose ()
 Disposes of the VideoDevice object's resources. More...

Protected Member Functions

virtual void Dispose (bool disposing)

Properties

string Name [get]
 The name of the device. More...
string Id [get]
 The ID of the device. More...

Detailed Description

Defines a video device (such as a camera).

Use the VideoCapturer.EnumerateDevices() method to get a list of available video devices on the system.

Member Function Documentation

◆ CreateVideoCapturer() [1/3]

VideoCapturer OpenTok.VideoCapturer.VideoDevice.CreateVideoCapturer ( VideoFormat  format)

Creates a video capturer that uses the provided video format.

Parameters
formatThe video format the video capturer should use.
Returns
The VideoCapturer.
See also
ListFormats()

◆ CreateVideoCapturer() [2/3]

VideoCapturer OpenTok.VideoCapturer.VideoDevice.CreateVideoCapturer ( int  width,
int  height,
int  fps = 30 
)

Creates a video capturer that uses the provided width, height, and frame rate. The video capturer will use the closest available settings.

Parameters
widthThe width of the video, in pixels.
Parameters
heightThe height of the video, in pixels.
Parameters
fpsThe frame rate of the video, in frames per second.
Returns
The VideoCapturer.

◆ CreateVideoCapturer() [3/3]

VideoCapturer OpenTok.VideoCapturer.VideoDevice.CreateVideoCapturer ( Resolution  resolution = Resolution.Medium,
FrameRate  frameRate = FrameRate.Fps30 
)

Creates a video capturer that uses the provided resolution and frame rate. The video capturer will use the closest available settings.

Parameters
resolutionThe resolution of the video, as defined by values in the Resolution enum.
Parameters
frameRateThe frame rate of the video, as defined by values in the FrameRate enum
Returns
The VideoCapturer.

◆ Dispose()

void OpenTok.VideoCapturer.VideoDevice.Dispose ( )

Disposes of the VideoDevice object's resources.

◆ ListFormats()

IList<VideoFormat> OpenTok.VideoCapturer.VideoDevice.ListFormats ( )

Returns a list of video formats available for the device.

Property Documentation

◆ Id

string OpenTok.VideoCapturer.VideoDevice.Id

The ID of the device.

◆ Name

string OpenTok.VideoCapturer.VideoDevice.Name

The name of the device.