-
Notifications
You must be signed in to change notification settings - Fork 5
/
microsoftTeams.media.VideoProps.yml
125 lines (125 loc) · 4.29 KB
/
microsoftTeams.media.VideoProps.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
### YamlMime:TSType
name: VideoProps
uid: '@microsoft/teams-js.microsoftTeams.media.VideoProps'
package: '@microsoft/teams-js'
summary: >-
All properties in VideoProps are optional and have default values in the
platform.
fullName: VideoProps
remarks: ''
isDeprecated: false
type: interface
properties:
- name: isFullScreenMode
uid: '@microsoft/teams-js.microsoftTeams.media.VideoProps.isFullScreenMode'
package: '@microsoft/teams-js'
summary: >-
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.
fullName: isFullScreenMode
remarks: ''
isDeprecated: false
syntax:
content: 'isFullScreenMode?: boolean'
return:
description: ''
type: boolean
- name: isStopButtonVisible
uid: '@microsoft/teams-js.microsoftTeams.media.VideoProps.isStopButtonVisible'
package: '@microsoft/teams-js'
summary: >-
Optional; controls the visibility of stop button in PictureInPicture
Mode. Default value is true, indicating the user will be able
to stop the video.
fullName: isStopButtonVisible
remarks: ''
isDeprecated: false
syntax:
content: 'isStopButtonVisible?: boolean'
return:
description: ''
type: boolean
- name: maxDuration
uid: '@microsoft/teams-js.microsoftTeams.media.VideoProps.maxDuration'
package: '@microsoft/teams-js'
summary: >-
Optional; the maximum duration in seconds after which the recording
should terminate automatically. Default value is defined by
the platform serving the API.
fullName: maxDuration
remarks: ''
isDeprecated: false
syntax:
content: 'maxDuration?: number'
return:
description: ''
type: number
- name: videoController
uid: '@microsoft/teams-js.microsoftTeams.media.VideoProps.videoController'
package: '@microsoft/teams-js'
summary: >-
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.
fullName: videoController
remarks: ''
isDeprecated: false
syntax:
content: 'videoController?: VideoController'
return:
description: ''
type: >-
@microsoft/teams-js.<xref
uid="@microsoft.teams-js.media.VideoController" />
inheritedProperties:
- name: cameraSwitcher
uid: '@microsoft/teams-js.microsoftTeams.media.VideoProps.cameraSwitcher'
package: '@microsoft/teams-js'
summary: >-
Optional; indicate if user is allowed to move between front and back
camera. Default value is true.
fullName: cameraSwitcher
remarks: ''
isDeprecated: false
syntax:
content: 'cameraSwitcher?: boolean'
return:
description: ''
type: boolean
inheritanceDescription: <b>Inherited From</b> MediaProps.cameraSwitcher
- name: sources
uid: '@microsoft/teams-js.microsoftTeams.media.VideoProps.sources'
package: '@microsoft/teams-js'
summary: >-
Optional; Lets the developer specify the media source, more than one can
be specified. Default value is both camera and gallery.
fullName: sources
remarks: ''
isDeprecated: false
syntax:
content: 'sources?: Source[]'
return:
description: ''
type: '@microsoft/teams-js.<xref uid="@microsoft.teams-js.media.Source" />[]'
inheritanceDescription: <b>Inherited From</b> MediaProps.sources
- name: startMode
uid: '@microsoft/teams-js.microsoftTeams.media.VideoProps.startMode'
package: '@microsoft/teams-js'
summary: >-
Optional; Specify in which mode the camera will be opened. *
Default value is Photo.
fullName: startMode
remarks: ''
isDeprecated: false
syntax:
content: 'startMode?: CameraStartMode'
return:
description: ''
type: >-
@microsoft/teams-js.<xref
uid="@microsoft.teams-js.media.CameraStartMode" />
inheritanceDescription: <b>Inherited From</b> MediaProps.startMode
extends: MediaProps