VideoProps interface

Package:

@microsoft/teams-js

All properties in VideoProps are optional and have default values in the platform.

Extends

MediaProps

Properties

isFullScreenMode	Optional; to determine if the video capturing flow needs to be launched in Full Screen Mode (Lens implementation) or PictureInPicture Mode (Native implementation). Default value is true, indicating video will always launch in Full Screen Mode via lens.
isStopButtonVisible	Optional; controls the visibility of stop button in PictureInPicture Mode. Default value is true, indicating the user will be able to stop the video.
maxDuration	Optional; the maximum duration in seconds after which the recording should terminate automatically. Default value is defined by the platform serving the API.
videoController	Optional; setting VideoController will register your app to listen to the lifecycle events during the video capture flow. Your app can also dynamically control the experience while capturing the video by notifying the host client.

Inherited Properties

cameraSwitcher	Optional; indicate if user is allowed to move between front and back camera. Default value is true.
sources	Optional; Lets the developer specify the media source, more than one can be specified. Default value is both camera and gallery.
startMode	Optional; Specify in which mode the camera will be opened. * Default value is Photo.

Property Details

isFullScreenMode

Optional; to determine if the video capturing flow needs to be launched in Full Screen Mode (Lens implementation) or PictureInPicture Mode (Native implementation). Default value is true, indicating video will always launch in Full Screen Mode via lens.

isFullScreenMode?: boolean

Property Value

boolean

isStopButtonVisible

Optional; controls the visibility of stop button in PictureInPicture Mode. Default value is true, indicating the user will be able to stop the video.

isStopButtonVisible?: boolean

Property Value

boolean

maxDuration

Optional; the maximum duration in seconds after which the recording should terminate automatically. Default value is defined by the platform serving the API.

maxDuration?: number

Property Value

number

videoController

Optional; setting VideoController will register your app to listen to the lifecycle events during the video capture flow. Your app can also dynamically control the experience while capturing the video by notifying the host client.

videoController?: VideoController

Property Value

@microsoft/teams-js.@microsoft.teams-js.media.VideoController

Inherited Property Details

cameraSwitcher

Optional; indicate if user is allowed to move between front and back camera. Default value is true.

cameraSwitcher?: boolean

Property Value

boolean

Inherited From MediaProps.cameraSwitcher

sources

Optional; Lets the developer specify the media source, more than one can be specified. Default value is both camera and gallery.

sources?: Source[]

Property Value

@microsoft/teams-js.@microsoft.teams-js.media.Source[]

Inherited From MediaProps.sources

startMode

Optional; Specify in which mode the camera will be opened. * Default value is Photo.

startMode?: CameraStartMode

Property Value

@microsoft/teams-js.@microsoft.teams-js.media.CameraStartMode

Inherited From MediaProps.startMode