ToiMediaPlayerBaseTimeshiftInfo Interface Reference


Description

This is the documentation for ToiMediaPlayerBaseTimeshiftInfo.
Information about the timeshift. Use toi.statics.ToiMediaPlayerBaseTimeshiftInfo.create(<state>, <bufferCapacity>, <bufferUsed>, <bufferStartPosition>, <recorderSessionId>, <assetId>) to create an instance of ToiMediaPlayerBaseTimeshiftInfo. The following parameters in the create method are optional: <assetId>. For the optional members that have default values, the values are: ; if they are not set from the portal, they will have the default value.

import "ToiMediaPlayerBaseTimeshiftInfo.idl";

List of all members.

Public Attributes

attribute
ToiMediaPlayerBase::TToiTimeshiftState 
state
attribute long bufferCapacity
attribute long bufferUsed
attribute long bufferStartPosition
attribute
ToiMediaSession::TToiSessionId 
recorderSessionId
attribute
ToiAssetManagerService::TToiAssetId 
assetId

Member Data Documentation

Technical Preview:
This field may change. The asset identifier for the recorded content

The total size of the timeshift buffer in seconds. The capacity will initially be the capacity requested in ToiMediaPlayer::startTimeshiftBuffering(), but may change if the internal timeshift buffer is not big enough to hold the requested capacity due to higher bitrate than expected.

The start position for the timeshift buffer in milliseconds. When playing from the timeshift buffer, the start position in combination with the players position (as received in event OnPositionChanged) gives the relative position in the buffer.

The used size of the allocated timeshift buffer in seconds. The buffer is full when (C++) BufferUsed is equal to (C++) BufferCapacity, but buffering may continue if timeshift is configured to use a circular buffer.

The session identifier for the recorder session buffering contents

The current media player timeshift state.