VideoProps interface
All properties in VideoProps are optional and have default values in the platform
- Extends
-
MediaProps
Properties
| is |
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. |
| is |
Optional; controls the visibility of stop button in PictureInPicture Mode. Default value is true, indicating the user will be able to stop the video. |
| max |
Optional; the maximum duration in seconds after which the recording should terminate automatically. Default value is defined by the platform serving the API. |
| video |
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. |
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?: booleanProperty 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?: booleanProperty 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?: numberProperty 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