Class MediaReceiver

Base class for media producers generating frames by receiving them from a remote peer.

Inheritance

Object

MediaReceiver

AudioReceiver

VideoReceiver

Namespace: Microsoft.MixedReality.WebRTC.Unity

Assembly: cs.temp.dll.dll

Syntax

public abstract class MediaReceiver : MonoBehaviour

Properties

IsLive

Is the media source currently producing frames received from the remote peer? This is true while the remote media track exists, which is notified by events on the AudioReceiver or VideoReceiver.

Declaration

public bool IsLive { get; }

Property Value

Type	Description
Boolean

MediaKind

Media kind of the receiver.

Declaration

public abstract MediaKind MediaKind { get; }

Property Value

Type	Description
MediaKind

MediaLine

Media line this receiver is paired with, if any.

Declaration

public MediaLine MediaLine { get; }

Property Value

Type	Description
MediaLine

Remarks

Note that this is set to the connected MediaLine only if the owning PeerConnection is awake. This will be automatically reset if the PeerConnection owning the MediaLineis destroyed.

Track

Remote track associated with this receiver. null if this object is not receiving at this time.

Declaration

public abstract MediaTrack Track { get; }

Property Value

Type	Description
MediaTrack

Remarks

This is always a or a

Transceiver

Transceiver this receiver is paired with, if any.

This is null until a remote description is applied which pairs the media line this receiver is associated with to a transceiver, or until the peer connection of this receiver's media line creates the receiver right before creating an SDP offer.

Declaration

public Transceiver Transceiver { get; }

Property Value

Type	Description
Transceiver

Methods

OnAddedToMediaLine(MediaLine)

Internal callback invoked when the media receiver is assigned to a media line.

Declaration

protected virtual void OnAddedToMediaLine(MediaLine mediaLine)

Parameters

Type	Name	Description
MediaLine	mediaLine	The new media line this receiver is assigned to.

OnDestroy()

Declaration

protected void OnDestroy()

OnPaired(MediaTrack)

Internal callback invoked when the receiver is paired with a media track.

Declaration

protected virtual void OnPaired(MediaTrack track)

Parameters

Type	Name	Description
MediaTrack	track	The media track this receiver is paired with.

Remarks

This will be called on the Unity update thread.

OnRemovedFromMediaLine(MediaLine)

Internal callback invoked when the media receiver is de-assigned from a media line.

Declaration

protected virtual void OnRemovedFromMediaLine(MediaLine mediaLine)

Parameters

Type	Name	Description
MediaLine	mediaLine	The old media line this receiver was assigned to.

OnUnpaired(MediaTrack)

Internal callback invoked when the receiver is unpaired from a media track.

Declaration

protected virtual void OnUnpaired(MediaTrack track)

Parameters

Type	Name	Description
MediaTrack	track	The media track this receiver was paired with.

Remarks

This will be called on the Unity update thread.