Our new developer documentation is now available. Please check it out!
Room.StartMedia
public virtual Task<RpcResult> StartMedia(MediaEncoder encoder)
public virtual Task<RpcResult> StartMedia(ushort mediaId, MediaRpcProperties properties)
Send a "StartMedia" RPC to the server to start the encoder for input.
Info
Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.
Parameters
| Name | Type | Description |
|---|---|---|
| encoder | MediaEncoder | input media |
| mediaId | UInt16 | id of input media |
| properties | MediaRpcProperties | arbitrary media data usually to identify the media on lost connections |
Returns
| Type | Description |
|---|---|
| Task<RpcResult> | Thunk task that will not run (see |
Variants
StartMedia(encoder)
public virtual Task<RpcResult> StartMedia(MediaEncoder encoder)
Send a "StartMedia" RPC to the server to start the encoder for input.
Warning
Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.
Parameters
| Name | Type | Description |
|---|---|---|
| encoder | MediaEncoder | input media |
Returns
| Type | Description |
|---|---|
| Task<RpcResult> | Thunk task that will not run (see |
StartMedia(mediaId, properties)
public virtual Task<RpcResult> StartMedia(ushort mediaId, MediaRpcProperties properties)
Send a "StartMedia" RPC with custom media-data to the server to start the encoder for input.
Warning
Be aware that the task is created for resolving Msgpack request/response result as Room. Unless handled correctly should not be awaited by the corresponding context.
Parameters
| Name | Type | Description |
|---|---|---|
| mediaId | UInt16 | id of input media |
| properties | MediaRpcProperties | arbitrary media data usually to identify the media on lost connections |
Returns
| Type | Description |
|---|---|
| Task<RpcResult> | Thunk task that will not run (see |