Developer Documentation

Room.StopMedia

public virtual Task<RpcResult> StopMedia(MediaEncoder encoder)
public virtual Task<RpcResult> StopMedia(ushort mediaId)

Send a "StopMedia" to the server to stop the encoder.

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

NameTypeDescription
encoderMediaEncoderinput media to stop
mediaIdUInt16raw id to stop

Returns

TypeDescription
Task<RpcResult>Thunk task that will not run (see )

Variants

StopMedia(encoder)

public virtual Task<RpcResult> StopMedia(MediaEncoder encoder)

Send a "StopMedia" to the server to stop the encoder.

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

NameTypeDescription
encoderMediaEncoderinput media to stop

Returns

TypeDescription
Task<RpcResult>Thunk task that will not run (see )

StopMedia(mediaId)

public virtual Task<RpcResult> StopMedia(ushort mediaId)

Send a "StopMedia" to the server to stop the encoder.

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

NameTypeDescription
mediaIdUInt16raw id to stop

Returns

TypeDescription
Task<RpcResult>Thunk task that will not run (see )