Options
All
  • Public
  • Public/Protected
  • All
Menu

Live fluid object that synchronizes media playback across multiple clients.

Hierarchy

  • DataObject
    • LiveMediaSession

Index

Constructors

  • new LiveMediaSession(props: IDataObjectProps<DataObjectTypes>): LiveMediaSession
  • Parameters

    • props: IDataObjectProps<DataObjectTypes>

    Returns LiveMediaSession

Properties

TypeName: "@microsoft/fluid-media:SharedMediaSession" = ...

The objects fluid type name.

factory: DataObjectFactory<LiveMediaSession, DataObjectTypes> = ...

The objects fluid type factory.

Accessors

  • Extension point that lets applications replace the default logic for throttling the sessions local sync behavior.

    remarks

    The LiveMediaCoordinator is fairly aggressive at wanting to keep the local media player in sync with the rest of the group. This aggressiveness can result in the coordinator sending new sync actions before the local player has finished responding to the previous sync action. The ActionThrottler gives apps fine grain control over how aggressive they want sync to be.

    By default, a RepeatedAction throttler is used which prevents the same sync action from being sent within an adjustable time period.

    Returns MediaSessionActionThrottler

  • Extension point that lets applications replace the default logic for throttling the sessions local sync behavior.

    remarks

    The LiveMediaCoordinator is fairly aggressive at wanting to keep the local media player in sync with the rest of the group. This aggressiveness can result in the coordinator sending new sync actions before the local player has finished responding to the previous sync action. The ActionThrottler gives apps fine grain control over how aggressive they want sync to be.

    By default, a RepeatedAction throttler is used which prevents the same sync action from being sent within an adjustable time period.

    Parameters

    Returns void

  • get isInitialized(): boolean
  • get isStarted(): boolean
  • get logger(): LiveTelemetryLogger

Methods

  • hasInitialized(): Promise<void>
  • initialize(acceptTransportChangesFrom?: UserMeetingRole[]): Promise<void>
  • initialize the object.

    Parameters

    • Optional acceptTransportChangesFrom: UserMeetingRole[]

      Optional. List of roles allowed to group transport operations like play/pause/seek/setTrack.

    Returns Promise<void>

Generated using TypeDoc