sdk/com.brightcove.player.captioning/BrightcoveCaptionFormat

BrightcoveCaptionFormat

open class BrightcoveCaptionFormat

A class for describing the format options of a caption source.

Author

Billy Hnath (bhnath@brightcove.com)

Jim Whisenant (jwhisenant@brightcove.com) - refactoring to better support adding new properties without their being automatically required

Types

open class Builder

The Builder interface to store BrightcoveCaptionFormat data.

Properties

BRIGHTCOVE_SCHEME

val BRIGHTCOVE_SCHEME: String = "brightcove://"

open val isDefault: Boolean

Functions

open fun builder(): BrightcoveCaptionFormat.Builder

Creates a new builder for the BrightcoveCaptionFormat class.

createCaptionFormat

open fun createCaptionFormat(type: String, language: String): BrightcoveCaptionFormat

open fun createCaptionFormat(type: String, language: String, label: String): BrightcoveCaptionFormat

Creates a caption object which will encapsulate the formatting data into a BrightcoveCaptionFormat object.

findMatchingLanguageIgnoreMimeType

open fun findMatchingLanguageIgnoreMimeType(pairList: List<out Pair<Uri, BrightcoveCaptionFormat>>, brightcoveCaptionFormat: BrightcoveCaptionFormat): Pair<Uri, BrightcoveCaptionFormat>

getFormattedLabel

open fun getFormattedLabel(): String

Get the label or the display language (if the label is a language code or empty).

hasInBandMetadataTrackDispatchType

open fun hasInBandMetadataTrackDispatchType(): Boolean

The in band metadata track dispatch type for this caption object

open fun isOfType(captionsTypes: Array<CaptionType>): Boolean

Checks if this caption format's type matches any of the specified caption types.

open fun label(): String

The label property for this caption object

open fun language(): String

The language code for this caption object

open fun toString(): String

open fun type(): String

The mimetype for this caption object

open fun validate()

Validation method for quick error checking against input data.