Class VideoTrackSource

This component represents a video track source, an entity which produces raw video frames for one or more tracks. The source can be added on a peer connection media line to be sent through that peer connection. It is a standalone object, independent of any peer connection, and can be shared with multiple of them.

Inheritance
Object
MediaTrackSource
VideoTrackSource
CustomVideoSource<T>
WebcamSource
Inherited Members
Namespace: Microsoft.MixedReality.WebRTC.Unity
Assembly: cs.temp.dll.dll
Syntax
public abstract class VideoTrackSource : MediaTrackSource

Fields

VideoStreamStarted

Event raised when the video stream started.

When this event is raised, the followings are true:

  • The property is a valid local video track.
  • The will become true just after the event is raised, by design.
Declaration
public VideoStreamStartedEvent VideoStreamStarted
Field Value
Type Description
VideoStreamStartedEvent
Remarks

This event is raised from the main Unity thread to allow Unity object access.

VideoStreamStopped

Event raised when the video stream stopped.

When this event is raised, the followings are true:

  • The property is null.
  • The has just become false right before the event was raised, by design.
Declaration
public VideoStreamStoppedEvent VideoStreamStopped
Field Value
Type Description
VideoStreamStoppedEvent
Remarks

This event is raised from the main Unity thread to allow Unity object access.

Properties

IsLive

Indicates if the source is currently producing frames.

Declaration
public override bool IsLive { get; }
Property Value
Type Description
Boolean
Overrides

MediaKind

Media kind of the track source.

Declaration
public override MediaKind MediaKind { get; }
Property Value
Type Description
MediaKind
Overrides

Source

Video track source object from the underlying C# library that this component encapsulates.

The object is owned by this component, which will create it and dispose of it automatically.

Declaration
public VideoTrackSource Source { get; }
Property Value
Type Description
VideoTrackSource

Methods

AttachSource(VideoTrackSource)

Declaration
protected void AttachSource(VideoTrackSource source)
Parameters
Type Name Description
VideoTrackSource source

DisposeSource()

Declaration
protected void DisposeSource()

See Also