fl-player/com.quickplay.vstb7.player.audio.browser/AudioPlayerBuilder

AudioPlayerBuilder

class AudioPlayerBuilder : MediaPlaylistPlayerBuilder

A builder for creating Player instances configured for audio playback.

This builder extends MediaPlaylistPlayerBuilder and is specialized for creating players that handle audio-only content, including support for background playback and integration with Android Auto head units. It allows for the configuration of player properties such as notifications and specific flags for automotive use cases.

Example usage:

val audioPlayer = AudioPlayerBuilder()
    .addMedia(mediaPlaylistItem)
    .isPlayerForHeadUnit(true)
    .playerNotificationProperties(notificationProperties)
    .build(applicationContext)

Also note that if a specific functionality is required such as starting the playback from a bookmark position you must provide that functionality using com.quickplay.vstb7.player.model.PlaybackProperties at player's build time.

Example:

val mediaPlaylistItem = MediaPlaylistItem.Builder(baseConfiguration).build()
val playbackProperties = PlaybackProperties()
playbackProperties.initialStartTimeMs = 60000L
val audioPlayer = AudioPlayerBuilder()
    .mediaPlaylistItem(mediaPlaylistItem)
    .playbackProperties(playbackProperties)
    .build(applicationContext)

Constructors

AudioPlayerBuilder

constructor()

Functions

build

open override fun build(platformContext: <Error class: unknown class>): Player

Builds a Player instance based on the supplied builder params.

customHeaders

fun customHeaders(customHeaders: Map<String, String>): <Error class: unknown class>

Sets custom headers used by Player's data source when making HTTP requests. By default it is null.

decoderConfiguration

fun decoderConfiguration(decoderConfiguration: DecoderConfiguration): <Error class: unknown class>

SetsDecoderConfiguration to configure Player's decoder.

enableSecurityChecks

fun enableSecurityChecks(policies: List<Int>? = null): <Error class: unknown class>

Enables SecurityPolicy.SecurityChecks.

excludeMediaSession

fun excludeMediaSession(excludeMediaSession: Boolean): <Error class: unknown class>

Indicates whether the media session should be excluded from creation. By default, QP Player is pre-integrated with MediaSession to ensure compliance with system media controls and voice control features like Google Assistant.

isPlayerForHeadUnit

fun isPlayerForHeadUnit(isPlayerForHeadUnit: Boolean = false): <Error class: unknown class>

This flag should be set if the auto head unit creates QPPlayer and listen to its event to use the Bookmark, Heartbeat capabilities.

logger

fun logger(logger: Logger): <Error class: unknown class>

Configures Logger used for call tracing.

mediaPlaylistItem

fun mediaPlaylistItem(mediaPlaylistItem: MediaPlaylistItem): <Error class: unknown class>

Sets initial MediaPlaylistItem. Additional MediaPlaylistItems can be added using Player's MediaPlaylistControllable API.

mediaPlaylistItems

fun mediaPlaylistItems(mediaPlaylistItems: List<MediaPlaylistItem>, playlistPreloadConfiguration: PlaylistPreloadConfiguration? = null): <Error class: unknown class>

Sets collection of MediaPlaylistItems used for sequential playback with optional PlaylistPreloadConfiguration. When the PlaylistPreloadConfiguration.preloadingDurationMs is specified and greater than DEFAULT_LONG_VAL the player tries to preload preloadingDurationMs e.g. five seconds of media for the next item in the playlist. Note that if you decide not to provide the PlaylistPreloadConfiguration instance the playlist media preloading is disabled. For convenience, PlaylistPreloadConfiguration provides default values for the configuration properties.

networkStack

fun networkStack(networkStack: NetworkStack = NetworkStack.BUILT_IN): <Error class: unknown class>

Configures the NetworkStack to be used for the playback. Default value is NetworkStack.BUILT_IN.

playbackProperties

fun playbackProperties(properties: PlaybackProperties): <Error class: unknown class>

Configures PlaybackProperties to apply for playback customization/optimization.

playerNotificationProperties

fun playerNotificationProperties(playerNotificationProperties: PlayerNotificationProperties): <Error class: unknown class>

Sets PlayerNotificationProperties to control how lock screen notifications should look like.

preferredAudioLanguage

fun preferredAudioLanguage(language: AudioLanguageInfo): <Error class: unknown class>

Sets the preferred audio language and associated track properties for the media player.

preferredSubtitleLanguage

fun preferredSubtitleLanguage(languageCode: String): <Error class: unknown class>

Sets the preferred language for subtitles.

renderingSurface

fun renderingSurface(surface: Surface): <Error class: unknown class>

Sets the surface to render the video into.

renderingView

fun renderingView(view: View): <Error class: unknown class>

Sets the view to render the video into.

repeatPlaybackOnStreamEnd

fun repeatPlaybackOnStreamEnd(repeatPlayback: Boolean): <Error class: unknown class>

Enables/disables repeated playback when stream reaches the end.

seekPreference

fun seekPreference(seekPreference: SeekPreference): <Error class: unknown class>

Set the seeking behaviour of the player.

userAgent

fun userAgent(agent: String): <Error class: unknown class>

Configures User-Agent string.