Partager via

VideoAndImageProps interface

  • Reference
Package:
@microsoft/teams-js

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

Extends

@microsoft/teams-js.@microsoft.teams-js.media.ImageProps,@microsoft/teams-js.@microsoft.teams-js.media.VideoProps

Inherited Properties

cameraSwitcher

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

Optional; indicate if image filtering mode is enabled on the selected image. Default value is false.
imageOutputFormats

Optional; Lets the developer specify the image output formats, more than one can be specified. Default value is Image.
ink

Optional; indicate if inking on the selected Image is allowed or not. Default value is true.
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.
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.
textSticker

Optional; indicate if putting text stickers on the selected Image is allowed or not. Default value is true.
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 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 VideoProps.cameraSwitcher

enableFilter

Optional; indicate if image filtering mode is enabled on the selected image. Default value is false.

enableFilter?: boolean

Property Value

boolean

Inherited From ImageProps.enableFilter

imageOutputFormats

Optional; Lets the developer specify the image output formats, more than one can be specified. Default value is Image.

imageOutputFormats?: ImageOutputFormats[]

Property Value

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

Inherited From ImageProps.imageOutputFormats

ink

Optional; indicate if inking on the selected Image is allowed or not. Default value is true.

ink?: boolean

Property Value

boolean

Inherited From ImageProps.ink

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

Inherited From VideoProps.isFullScreenMode

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

Inherited From VideoProps.isStopButtonVisible

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

Inherited From VideoProps.maxDuration

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 VideoProps.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 VideoProps.startMode

textSticker

Optional; indicate if putting text stickers on the selected Image is allowed or not. Default value is true.

textSticker?: boolean

Property Value

boolean

Inherited From ImageProps.textSticker

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 From VideoProps.videoController