Class Player

Constructs a new Player instance, optionally with a custom connector This doesn't start the playback, you must call Player.start method By default if no connector is indicated it uses a WSController (WebSocket IController) excepting if Connect.Params.endPoint is prefixed with a http:// protocol in such case it uses instead a HTTPConnector (HTTP IConnector). To force a HTTPConnector build explicitly with HTTPConnector as Connector argument.

Example

// Default build
const player = new Player();
player.start({
   endPoint: address, // if address is prefixed by `http://` it uses a HTTPConnector (HTTP-WHIP), otherwise it uses a WSController (WebSocket)
   streamName: 'as+bc3f535f-37f3-458b-8171-b4c5e77a6137'
});
// Force connector selection whatever the address used in endPoint
const player = new Player(isWHIP ? HTTPConnector : WSController);
player.start({
  endPoint: address, // optional protocol prefix has no incidence on connector selection
 streamName: 'as+bc3f535f-37f3-458b-8171-b4c5e77a6137'
})
Copy

Index of the audio track, can be undefined if player is not playing

Sets the current audio track to the index provided, it can be set before calling Player.start to select the initial audio track, or set after Player.start to fix track and disable MBR While playing you can set it to undefined to activate MBR when session is controllable

Returns the IConnector instance, or undefined if stream is not starting.

Returns the IController instance when starting with a connector with controllable ability, or undefined if stream is not starting or stream is not controllable.

The list of tracks currently receiving

Set the data track ids to receive

Returns the Metadata object description

Last playing information, such as current position and playback buffer bounds See PlayingInfos

Returns true when player is running (between a Player.start and a Player.stop)

Playable media stream as specified by MediaStream

Stream name, for example as+bc3f535f-37f3-458b-8171-b4c5e77a6137

State of the stream as indicated by the server

Index of the video track, can be undefined if player is not playing

Sets the current video track to the index provided, it can be set before calling Player.start to select the initial video track, or set after Player.start to fix track and disable MBR While playing you can set it to undefined to activate MBR when session is controllable

Returns connection info, such as round trip time, requests sent and received, bytes sent and received, and bitrates NOTE: This call is resource-intensive for the CPU.

Event fired when stream state is changing

Starts playing the stream The connector is determined automatically from Connect.Params.endPoint if not forced in the constructor.

Instead to use a Connect.Params you can prefer use a already built StreamMetadata instance to the same end-point, it allows to discover tracks in amount and initialize track selection to start playback.

The multiBitrate option can take three different types of value:

• A MBRParams object to configured the default MBRLinear implementation, default value {}
• undefined to disable MBR management
• Use a custom MBRAbstract implementation instance

In addition you can disable MBR while playing by set audio or video track to an explicit value (Player.videoTrack and Player.audioTrack).

Example

// Default start with MBR activated
player.start({
   endPoint: address,
   streamName: 'as+bc3f535f-37f3-458b-8171-b4c5e77a6137'
});
// Start with selected initial track, in using a StreamMetadata object preinitialized
const streamMetadata = new StreamMetadata({
   endPoint: address,
   streamName: 'as+bc3f535f-37f3-458b-8171-b4c5e77a6137'
});
streamMetadata.onMetadata = metadata => {
   // start to play with higher bitrate selection (audios and videos are sorted by descending BPS)
   player.audioTrack = metadata.audios[0].idx;
   player.videoTrack = metadata.videos[0].idx;
   // give the streamMetadata channel to reuse instead of opening a new again
   player.start(streamMetadata);
   // Now MBR select automatically the best tracks regarding network congestion
   ...
   // Fix audioTrack to the high rendition (disable MBR for audio track)
   player.audioTrack = 1;
   ...
   // Reactivate MBR for audio
   player.audioTrack = undefined;
}
Copy

Stops playing the stream

Event fired when data is received in the stream

Event fired when metadata is present in the stream

Event fired every second to report information while content plays

Event fired when streaming starts

Event fired when streaming stops