OpenTok.IVideoCapturer

public interface IVideoCapturer

Methods

Name Description
Destroy() Called when the Publisher object using this VideoFrameConsumer is destroyed.
GetCaptureSettings() → {VideoCaptureSettings} The OpenTok Windows SDK calls this method to get the video settings for the video capturer.
GetVideoContentHint() → {VideoContentHint} This method will return the current value of video content hint.
Init(frameConsumer)
SetVideoContentHint(contentHint) This method will set the video content hint to one of the enum values given in VideoContentHint.
Start() Called when the Publisher starts publishing video.
Stop() Called when the Publisher stops publishing video.

Destroy()

Called when the Publisher object using this VideoFrameConsumer is destroyed.

GetCaptureSettings() → {VideoCaptureSettings}

The OpenTok Windows SDK calls this method to get the video settings for the video capturer. In your implementation of this method, create a new settings object to define the video settings to be used.

Returns:

VideoCaptureSettings

GetVideoContentHint() → {VideoContentHint}

This method will return the current value of video content hint.

Returns:

VideoContentHint

Init(frameConsumer)

Parameters:
Name Type Description
frameConsumer IVideoFrameConsumer The instance of the IVideoFrameConsumer to use.

SetVideoContentHint(contentHint)

This method will set the video content hint to one of the enum values given in VideoContentHint. By default it will be set to NONE.

Parameters:
Name Type Description
contentHint VideoContentHint

Start()

Called when the Publisher starts publishing video. Call the IVideoFrameConsumer.Consume(VideoFrame) method whenever a new frame is available.

Stop()

Called when the Publisher stops publishing video.