amazon-chime-sdk / com.amazonaws.services.chime.sdk.meetings.audiovideo / DefaultAudioVideoController / startLocalVideo

startLocalVideo

fun startLocalVideo(): Unit

Start local video and begin transmitting frames from an internally held DefaultCameraCaptureSource. stopLocalVideo will stop the internal capture source if being used.

Calling this after passing in a custom VideoSource will replace it with the internal capture source.

This function will only have effect if start has already been called

fun startLocalVideo(config: LocalVideoConfiguration): Unit

Start local video with configuration and begin transmitting frames from an internally held DefaultCameraCaptureSource. stopLocalVideo will stop the internal capture source if being used.

Calling this after passing in a custom VideoSource will replace it with the internal capture source.

This function will only have effect if start has already been called. Calling this function repeatedly will update configuration of local video. If maxBitRateKbps is not set, it will be self adjusted depending on number of users and videos in the meeting

Parameters

config - : LocalVideoConfiguration - The configuration of emitted video stream, e.g. maxBitRateKbps

fun startLocalVideo(source: VideoSource): Unit

Start local video with a provided custom VideoSource which can be used to provide custom VideoFrame objects to be transmitted to remote clients

Calling this function repeatedly will replace the previous VideoSource as the one being transmitted. It will also stop and replace the internal capture source if startLocalVideo was called with no arguments.

Read custom video guide for details.

Parameters

source - : VideoSource - The source of video frames to be sent to other clients

fun startLocalVideo(source: VideoSource, config: LocalVideoConfiguration): Unit

Start local video with with configuration and a provided custom VideoSource which can be used to provide custom VideoFrame objects to be transmitted to remote clients

Calling this function repeatedly will replace the previous VideoSource as the one being transmitted. It will update configuration of local video. It will also stop and replace the internal capture source if startLocalVideo was called with no arguments. If maxBitRateKbps is not set, it will be self adjusted depending on number of users and videos in the meeting

Read custom video guide for details.

Parameters

source - : VideoSource - The source of video frames to be sent to other clients

config - : LocalVideoConfiguration - The configuration of emitted video stream, e.g. maxBitRateKbps