LocalVideo
The LocalVideo model allows enabling and disabling the local participant's video.
This model is supported only in SDK 3.7 and later.
Methods
start
▸ start(completion: ((_ error: Error?) -> Void)?)
Enables the local participant's video and sends the video to a conference. The method is available only to participants who joined a conference using the join method; it is not available for listeners.
The start method requires a few seconds to become effective.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
completion | ((_ error: NSError) -> Void)? | nil | The block to execute when the query completes. |
start
▸ start(isDefaultFrontFacing: Bool, completion: ((_ error: Error?) -> Void)?)
Enables the local participant's video and sends the video to a conference. The method is available only to participants who joined a conference using the join method; it is not available for listeners.
The start method requires a few seconds to become effective.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
isDefaultFrontFacing | Bool | true | Indicates a camera that should be enabled. True indicates that the application should use the front-facing camera, false indicates that the application should enable the back-facing camera. |
completion | ((_ error: NSError) -> Void)? | nil | The block to execute when the query completes. |
stop
▸ stop(completion: ((_ error: Error?) -> Void)?)
Disables the local participant's video and stops sending the video to a conference.
The stop method requires a few seconds to become effective.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
completion | ((_ error: NSError) -> Void)? | nil | The block to execute when the query completes |
Updated about 1 month ago