Represents a broadcast layout of an Vonage Video API session. More...
| Public Types | |
| enum | LayoutType { LayoutType.Pip, LayoutType.BestFit, LayoutType.VerticalPresentation, LayoutType.HorizontalPresentation, LayoutType.Custom } |
| Defines values for the layout parameter of the StartBroadcast method of the OpenTok class. More... |
| Public Member Functions | |
| BroadcastLayout (ScreenShareLayoutType type) | |
| Initalizes a Broadcast layout with the given ScreenShareLayoutType, automatically setting the Type to BestFit. More... | |
| BroadcastLayout (LayoutType type) | |
| Initalizes a BroadcastLayout with the given LayoutType More... | |
| BroadcastLayout (LayoutType type, string stylesheet) | |
| Initalizes a BroadcastLayout with the given LayoutType and stylesheet - note Type must be LayoutType.Custom More... |
| Properties | |
| LayoutType | Type [get, set] |
| The Layout type More... | |
| string | Stylesheet [get, set] |
| The Stylesheet for the Custom Layout More... | |
| ScreenShareLayoutType? | ScreenShareType [get, set] |
| The LayoutTypeto use when there is a screen-sharing stream in the session. Note that to use this property, you must set the Type property to LayoutType.BestFit and leave the Stylesheet property unset. For more information, see Layout types for screen sharing. NOTE: LayoutType.Custom is not valid for this property More... |
Detailed Description
Represents a broadcast layout of an Vonage Video API session.
Member Enumeration Documentation
LayoutType
Defines values for the layout parameter of the StartBroadcast method of the OpenTok class.
| Enumerator | |
|---|---|
| Pip | Picture-in-Picture |
| BestFit | Best Fit |
| VerticalPresentation | Vertical Presentation |
| HorizontalPresentation | Horizontal Presentation |
| Custom | Custom Layout |
Constructor & Destructor Documentation
BroadcastLayout() [1/3]
| OpenTokSDK.BroadcastLayout.BroadcastLayout | ( | ScreenShareLayoutType | type | ) |
Initalizes a Broadcast layout with the given ScreenShareLayoutType, automatically setting the Type to BestFit.
Parameters : | | | | --- | --- | | type | |
BroadcastLayout() [2/3]
| OpenTokSDK.BroadcastLayout.BroadcastLayout | ( | LayoutType | type | ) |
Initalizes a BroadcastLayout with the given LayoutType
Parameters : | | | | --- | --- | | type | |
BroadcastLayout() [3/3]
| OpenTokSDK.BroadcastLayout.BroadcastLayout | ( | LayoutType | type, |
| string | stylesheet | ||
| ) |
Initalizes a BroadcastLayout with the given LayoutType and stylesheet - note Type must be LayoutType.Custom
Parameters : | | | | --- | --- | | type | | | stylesheet | A string de |
Property Documentation
ScreenShareType
The LayoutTypeto use when there is a screen-sharing stream in the session. Note that to use this property, you must set the Type property to LayoutType.BestFit and leave the Stylesheet property unset. For more information, see Layout types for screen sharing. NOTE: LayoutType.Custom is not valid for this property
Stylesheet
The Stylesheet for the Custom Layout
Type
The Layout type