Class BufferApi

Provides the means to configure buffer settings and to query the current buffer state. Accessible through Player.buffer.

Index

Constructors

Properties

Methods

getLevel setTargetLevel

Constructors

constructor

new BufferApi(playerId: string): BufferApi
Parameters
- playerId: string
Returns BufferApi
- Defined in bufferApi.ts:77

Properties

`Readonly`nativeId

nativeId: string

The native player id that this buffer api is attached to.

Methods

getLevel

getLevel(type: BufferType): Promise<BufferLevels>
Gets the buffer level from the Player
Parameters
- type: BufferType
  The BufferType to return the level for.
Returns Promise<BufferLevels>
a BufferLevels that contains BufferLevel values for audio and video.
- Defined in bufferApi.ts:86

setTargetLevel

setTargetLevel(type: BufferType, value: number): Promise<void>
Sets the target buffer level for the chosen buffer BufferType across all MediaType options.
Parameters
- type: BufferType
  The BufferType to set the target level for. On iOS and tvOS, only BufferType.FORWARD_DURATION is supported.
- value: number
  The value to set. On iOS and tvOS when passing 0, the player will choose an appropriate forward buffer duration suitable for most use-cases. On Android setting to 0 will have no effect.
Returns Promise<void>
- Defined in bufferApi.ts:96