TransceiverConfig
Transceiver Config for managed media
Extends
MediaBaseConfig
Properties
| Property | Type | Default value | Description | Overrides | Inherited from |
|---|---|---|---|---|---|
allowChangeOfMediaDirection | boolean | undefined | Whether to allow actively change of media direction | - | - |
content | string | 'main' | Content Attributes See https://www.rfc-editor.org/rfc/rfc4796#section-5 | - | - |
direction | RTCRtpTransceiverDirection | undefined | Can be any of these sendrecv, sendonly, recvonly and inactive | - | - |
dirty | boolean | undefined | - | - | MediaBaseConfig.dirty |
kind | "audio" | "video" | undefined | Either audio or video | MediaBaseConfig.kind | - |
mediaDescription? | PexipMediaLine | undefined | - | - | - |
relativeDirection | boolean | undefined | The flag to indicate whether to use relative direction which corresponding to the offer, e.g. Offer "sendonly" <--> Answer "recvonly" From https://www.rfc-editor.org/rfc/rfc3264.html#section-6.1 > If a stream is offered as sendonly, the corresponding stream MUST be > marked as recvonly or inactive in the answer. If a media stream is > listed as recvonly in the offer, the answer MUST be marked as > sendonly or inactive in the answer. If an offered media stream is > listed as sendrecv (or if there is no direction attribute at the > media or session level, in which case the stream is sendrecv by > default), the corresponding stream in the answer MAY be marked as > sendonly, recvonly, sendrecv, or inactive. If an offered media > stream is listed as inactive, it MUST be marked as inactive in the > answer. | - | - |
remoteStreams? | readonly MediaStream[] | undefined | - | - | - |
sendEncodings? | RTCRtpEncodingParameters[] | undefined | A list of RTCRtpEncodingParameters objects, each specifying the parameters for a single codec that could be used to encode the track's media | - | - |
streams | MediaStream[] | undefined | A list of local MediaStream objects to add to the transceiver's RTCRtpSender | - | - |
track | undefined | null | MediaStreamTrack | undefined | A MediaStreamTrack to associate with the transceiver | - | - |
transceiver | undefined | RTCRtpTransceiver | undefined | - | - | - |
Methods
release()
release(): void;
Returns
void
syncDirection()
syncDirection(): void;
Returns
void
syncSenderParameters()
syncSenderParameters(): Promise<void>;
Returns
Promise<void>
syncSenderTrack()
syncSenderTrack(): Promise<void>;
Returns
Promise<void>
syncStreams()
syncStreams(): void;
Returns
void
syncTransceiver()
syncTransceiver(peer, config?): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
peer | RTCPeerConnection |
config? | SyncTransceiverOption |
Returns
Promise<void>
toString()
toString(): string;
Returns
string
Inherited from
MediaBaseConfig.toString