PlayerMode Enum

Definition

Namespace:

Microsoft.Rtc.Collaboration.AudioVideo

Assembly:

Microsoft.Rtc.Collaboration.dll

The current mode of the player.

public enum class PlayerMode

public enum PlayerMode

type PlayerMode = 

Public Enum PlayerMode

Inheritance

Enum

PlayerMode

Fields

Automatic	0	Automatic mode.
Manual	1	Manual mode.

Remarks

In Automatic mode, the player starts and stops automatically, based on the status of the attached AudioVideoFlow instance.

The player is started by calling the Start() method, but it will not begin playing until at least one of the attached AudioVideoFlow instances is in the Active state.

The player will automatically stop whenever there is no active AudioVideoFlow attached to it.

In an outbound call to an endpoint that streams early media, AudioVideoFlow can become Active before the callee accepts the call. In this case, a player in Automatic mode begins playing as soon as there is an active AudioVideoFlow, so clipping might occur. To avoid this situation, it is recommended that you use Manual mode and wait until the call is established.

In Manual mode, the player behaves independently of the attached AudioVideoFlow instance.

If the player is in Manual mode, and Start() is called before an AudioVideoFlow is attached, or if the attached AudioVideoFlow is not in the Active state, the player updates its playing index appropriately in real time.