VideoCapturerProvider

The VideoCapturerProvider model is an interface responsible for providing VideoCapturer on demand for the Media Engine. Implements are responsible of tracking the capturers that they send to the engine. The SDK does not manage the switch when a switchable capturer is provided. The switch needs to be managed by the provider.

Available in the package com.voxeet.android.media.utils.VideoCapturerProvider.

Methods

createVideoCapturer

▸ createVideoCapturer(@Nullable optionalName: String): VideoCapturerBundle

Creates the VideoCapturer.

Parameters

Name	Type	Description
optionalName	String	nullable the optional name of the VideoCapturer

Returns: @Nullable VideoCapturerBundle - the VideoCapturerBundle or a null value that cancels the capturer creation.

onVideoCapturerDisposed

▸ onVideoCapturerDisposed(@NonNull videoCapturer: VideoCapturer): void

Callback called from the MediaEngine to indicate the given VideoCapturer has been stopped.

Parameters

Name	Type	Description
videoCapturer	VideoCapturer	non null stopped instance.

changeCaptureFormat

▸ changeCaptureFormat(width: int, height: int, frameRate: int): boolean

Changes the capture format for the currently opened VideoCapturer instance.

Parameters

Name	Type	Description
width	int	The requested width.
height	int	The requested height.
frameRate	int	The requested frame rate.

Returns: boolean - The flag indicating whether the call is successful.

getCurrentCapturerName

▸ getCurrentCapturerName(): String

Get the name of current capturer provider.

Returns: String - The name of the current capturer provider.

clear

▸ clear(): void

Releases locks on objects.