Class Player

Optional analytics

buffer

isDestroyed

isInitialized

Optional source

canPlayAtPlaybackSpeed

• canPlayAtPlaybackSpeed(playbackSpeed): Promise<undefined | boolean>

• Checks the possibility to play the media at specified playback speed.

  Parameters

  • playbackSpeed: number

    The playback speed to check.

  Returns Promise<undefined | boolean>

  true if it's possible to play the media at the specified playback speed, otherwise false. On Android it always returns undefined.

  Platform

  iOS, tvOS

castStop

• castStop(): void

• Stops casting the current video. Has no effect if Player.isCasting is false.

  Returns void

  Platform

  iOS, Android

castVideo

• castVideo(): void

• Initiates casting the current video to a cast-compatible remote device. The user has to choose to which device it should be sent.

  Returns void

  Platform

  iOS, Android

destroy

• destroy(): void

• Destroys the native Player and releases all of its allocated resources.

  Returns void

getAudioTrack

• getAudioTrack(): Promise<null | AudioTrack>

• Returns Promise<null | AudioTrack>

  The currently selected audio track or null.

getAvailableAudioTracks

• getAvailableAudioTracks(): Promise<AudioTrack[]>

• Returns Promise<AudioTrack[]>

  An array containing AudioTrack objects for all available audio tracks.

getAvailableSubtitles

• getAvailableSubtitles(): Promise<SubtitleTrack[]>

• Returns Promise<SubtitleTrack[]>

  An array containing SubtitleTrack objects for all available subtitle tracks.

getAvailableVideoQualities

• getAvailableVideoQualities(): Promise<VideoQuality[]>

• Returns an array containing all available video qualities the player can adapt between.

  Returns Promise<VideoQuality[]>

  An array containing all available video qualities the player can adapt between.

getCurrentTime

• getCurrentTime(mode?): Promise<number>

• Parameters

  • mode: "relative" | "absolute" = 'absolute'

    The time mode to specify: an absolute UNIX timestamp ('absolute') or relative time ('relative').

  Returns Promise<number>

  The current playback time in seconds.

  For VoD streams the returned time ranges between 0 and the duration of the asset.

  For live streams it can be specified if an absolute UNIX timestamp or a value relative to the playback start should be returned.

getDuration

• getDuration(): Promise<number>

• Returns Promise<number>

  The total duration in seconds of the current video or INFINITY if it’s a live stream.

getMaxTimeShift

• getMaxTimeShift(): Promise<number>

• The limit in seconds for time shifting. This value is either negative or 0 and it is always 0 if the active Source is not a live stream or no sources are loaded.

  Returns Promise<number>

getPlaybackSpeed

• getPlaybackSpeed(): Promise<number>

• Returns Promise<number>

  The player's current playback speed.

  See

  setPlaybackSpeed for details on which values playback speed can assume.

getSubtitleTrack

• getSubtitleTrack(): Promise<null | SubtitleTrack>

• Returns Promise<null | SubtitleTrack>

  The currently selected SubtitleTrack or null.

getThumbnail

• getThumbnail(time): Promise<null | Thumbnail>

• Parameters

  • time: number

    The time in seconds for which to retrieve the thumbnail.

  Returns Promise<null | Thumbnail>

  a Thumbnail for the specified playback time for the currently active source if available. Supported thumbnail formats are:

  • WebVtt configured via SourceConfig.thumbnailTrack, on all supported platforms
  • HLS Image Media Playlist in the multivariant playlist, Android-only
  • DASH Image Adaptation Set as specified in DASH-IF IOP, Android-only If a WebVtt thumbnail track is provided, any potential in-manifest thumbnails are ignored on Android.

getTimeShift

• getTimeShift(): Promise<number>

• The current time shift of the live stream in seconds. This value is always 0 if the active Source is not a live stream or no sources are loaded.

  Returns Promise<number>

getVideoQuality

• getVideoQuality(): Promise<VideoQuality>

• Returns the currently selected video quality.

  Returns Promise<VideoQuality>

  The currently selected video quality.

getVolume

• getVolume(): Promise<number>

• Returns Promise<number>

  The player's current volume level.

initialize

• initialize(): void

• Allocates the native Player instance and its resources natively.

  Returns void

isAd

• isAd(): Promise<boolean>

• Returns Promise<boolean>

  true while an ad is being played back or when main content playback has been paused for ad playback.

  Platform

  iOS, Android

isAirPlayActive

• isAirPlayActive(): Promise<boolean>

• Returns Promise<boolean>

  true when media is played externally using AirPlay.

  Remarks

  Only available for iOS devices.

isAirPlayAvailable

• isAirPlayAvailable(): Promise<boolean>

• Returns Promise<boolean>

  true when AirPlay is available.

  Remarks

  Only available for iOS devices.

isCastAvailable

• isCastAvailable(): Promise<boolean>

• Whether casting to a cast-compatible remote device is available. CastAvailableEvent signals when casting becomes available.

  Returns Promise<boolean>

  Platform

  iOS, Android

isCasting

• isCasting(): Promise<boolean>

• Whether video is currently being casted to a remote device and not played locally.

  Returns Promise<boolean>

  Platform

  iOS, Android

isLive

• isLive(): Promise<boolean>

• Returns Promise<boolean>

  true if the displayed video is a live stream.

isMuted

• isMuted(): Promise<boolean>

• Returns Promise<boolean>

  true if the player is muted.

isPaused

• isPaused(): Promise<boolean>

• Returns Promise<boolean>

  true if the player has started playback but it's currently paused.

isPlaying

• isPlaying(): Promise<boolean>

• Returns Promise<boolean>

  true if the player is currently playing, i.e. has started and is not paused.

load

• load(sourceConfig): void

• Loads a new Source from sourceConfig into the player.

  Parameters

  • sourceConfig: SourceConfig

  Returns void

loadOfflineContent

• loadOfflineContent(offlineContentManager, options?): void

• Loads the downloaded content from OfflineContentManager into the player.

  Parameters

  • offlineContentManager: OfflineContentManager
  • Optional options: OfflineSourceOptions

  Returns void

loadSource

• loadSource(source): void

• Loads the given Source into the player.

  Parameters

  • source: Source

  Returns void

mute

• mute(): void

• Mutes the player if an audio track is available. Has no effect if the player is already muted.

  Returns void

pause

• pause(): void

• Pauses the video if it is playing. Has no effect if the player is already paused.

  Returns void

play

• play(): void

• Starts or resumes playback after being paused. Has no effect if the player is already playing.

  Returns void

scheduleAd

• scheduleAd(adItem): void

• Dynamically schedules the AdItem for playback. Has no effect if there is no active playback session.

  Parameters

  • adItem: AdItem

    Ad to be scheduled for playback.

  Returns void

  Platform

  iOS, Android

seek

• seek(time): void

• Seeks to the given playback time specified by the parameter time in seconds. Must not be greater than the total duration of the video. Has no effect when watching a live stream since seeking is not possible.

  Parameters

  • time: number

    The time to seek to in seconds.

  Returns void

setAudioTrack

• setAudioTrack(trackIdentifier): Promise<void>

• Sets the audio track to the ID specified by trackIdentifier. A list can be retrieved by calling getAvailableAudioTracks.

  Parameters

  • trackIdentifier: string

    The AudioTrack.identifier to be set.

  Returns Promise<void>

setMaxSelectableBitrate

• setMaxSelectableBitrate(bitrate): void

• Sets the upper bitrate boundary for video qualities. All qualities with a bitrate that is higher than this threshold will not be eligible for automatic quality selection.

  Can be set to null for no limitation.

  Parameters

  • bitrate: null | number

  Returns void

setPlaybackSpeed

• setPlaybackSpeed(playbackSpeed): void

• Sets the playback speed of the player. Fast forward, slow motion and reverse playback are supported.

  Parameters

  • playbackSpeed: number

    The playback speed to set.

  Returns void

  Note

  • Slow motion is indicated by values between 0 and 1.
  • Fast forward by values greater than 1.
  • Slow reverse is used by values between 0 and -1, and fast reverse is used by values less than -1. iOS and tvOS only.

  Note

  Negative values are ignored during Casting and on Android.

  Note

  During reverse playback the playback will continue until the beginning of the active source is reached. When reaching the beginning of the source, playback will be paused and the playback speed will be reset to its default value of 1. No PlaybackFinishedEvent will be emitted in this case.

setSubtitleTrack

• setSubtitleTrack(trackIdentifier?): Promise<void>

• Sets the subtitle track to the ID specified by trackIdentifier. A list can be retrieved by calling getAvailableSubtitles.

  Parameters

  • Optional trackIdentifier: string

    The SubtitleTrack.identifier to be set.

  Returns Promise<void>

setVideoQuality

• setVideoQuality(qualityId): void

• Sets the video quality.

  Parameters

  • qualityId: String

    value obtained from VideoQuality's id property, which can be obtained via Player.getAvailableVideoQualities() to select a specific quality. To use automatic quality selection, 'auto' can be passed here.

  Returns void

  Remarks

  Only available on Android.

  Platform

  Android

setVolume

• setVolume(volume): void

• Sets the player's volume between 0 (silent) and 100 (max volume).

  Parameters

  • volume: number

    The volume level to set.

  Returns void

skipAd

• skipAd(): void

• Skips the current ad. Has no effect if the current ad is not skippable or if no ad is being played back.

  Returns void

  Platform

  iOS, Android

timeShift

• timeShift(offset): void

• Shifts the time to the given offset in seconds from the live edge. The resulting offset has to be within the timeShift window as specified by maxTimeShift (which is a negative value) and 0. When the provided offset is positive, it will be interpreted as a UNIX timestamp in seconds and converted to fit into the timeShift window. When the provided offset is negative, but lower than maxTimeShift, then it will be clamped to maxTimeShift. Has no effect for VoD.

  Has no effect if no sources are loaded.

  Parameters

  • offset: number

    Target offset from the live edge in seconds.

  Returns void

unload

• unload(): void

• Unloads all Sources from the player.

  Returns void

unmute

• unmute(): void

• Unmutes the player if it is muted. Has no effect if the player is already unmuted.

  Returns void