Class BufferApi

constructor

• new BufferApi(playerId): BufferApi

• Parameters

  • playerId: string

  Returns BufferApi

Readonly nativeId

getLevel

• getLevel(type): 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.

setTargetLevel

• setTargetLevel(type, value): 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>