-
Notifications
You must be signed in to change notification settings - Fork 6
/
microsoftTeams.media.VideoController.yml
59 lines (59 loc) · 2.04 KB
/
microsoftTeams.media.VideoController.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
### YamlMime:TSType
name: VideoController
uid: '@microsoft/teams-js.microsoftTeams.media.VideoController'
package: '@microsoft/teams-js'
summary: >-
VideoController class is used to communicate between the app and the host
client during the video capture flow.
fullName: VideoController
remarks: ''
isDeprecated: false
type: class
constructors:
- name: VideoController(VideoControllerCallback)
uid: '@microsoft/teams-js.microsoftTeams.media.VideoController.constructor'
package: '@microsoft/teams-js'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'new VideoController(controllerCallback?: VideoControllerCallback)'
parameters:
- id: controllerCallback
type: >-
@microsoft/teams-js.<xref
uid="@microsoft.teams-js.media.VideoControllerCallback" />
description: ''
inheritedMethods:
- name: 'stop((err?: SdkError) => void)'
uid: '@microsoft/teams-js.microsoftTeams.media.VideoController.stop'
package: '@microsoft/teams-js'
summary: >-
Optional; Function to programatically stop the ongoing media event.
remarks: ''
isDeprecated: false
syntax:
content: 'function stop(callback?: (err?: SdkError) => void)'
parameters:
- id: callback
type: '(err?: SdkError) => void'
description: >-
is used to send app if host client has successfully stopped the
event or not
inheritanceDescription: <b>Inherited From</b> MediaController.stop
methods:
- name: notifyEventToApp(MediaControllerEvent)
uid: '@microsoft/teams-js.microsoftTeams.media.VideoController.notifyEventToApp'
package: '@microsoft/teams-js'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'function notifyEventToApp(mediaEvent: MediaControllerEvent)'
parameters:
- id: mediaEvent
type: MediaControllerEvent
description: ''
extends: >-
MediaController<@microsoft/teams-js.<xref
uid="@microsoft.teams-js.media.VideoControllerCallback" />>