sdk/com.brightcove.player/Constants

Constants

open class Constants

Created by rsubramaniam on 10/2/17.

Constructors

Constants

constructor()

Types

Encoding

@Retention(value = RetentionPolicy.SOURCE)

annotation class Encoding

Represents an audio encoding, or an invalid or unset value.

PcmEncoding

@Retention(value = RetentionPolicy.SOURCE)

annotation class PcmEncoding

Represents a PCM audio encoding, or an invalid or unset value.

SelectionFlags

@Retention(value = RetentionPolicy.SOURCE)

annotation class SelectionFlags

Track selection flags.

SelectionReason

@Retention(value = RetentionPolicy.SOURCE)

annotation class SelectionReason

Define of selection reason constants.

StereoMode

@Retention(value = RetentionPolicy.SOURCE)

annotation class StereoMode

The stereo mode for 360/3D/VR videos.

Properties

EMPTY_HTTPREQUESTCONFIG

val EMPTY_HTTPREQUESTCONFIG: String = "HttpRequestConfig object is empty."

The error message for a null Catalog object

ENCODING_AC3

val ENCODING_AC3: Int

ENCODING_DTS

val ENCODING_DTS: Int

ENCODING_DTS_HD

val ENCODING_DTS_HD: Int

ENCODING_E_AC3

val ENCODING_E_AC3: Int

ENCODING_INVALID

val ENCODING_INVALID: Int

ENCODING_PCM_16BIT

val ENCODING_PCM_16BIT: Int

ENCODING_PCM_24BIT

val ENCODING_PCM_24BIT: Int = -2147483648

PCM encoding with 24 bits per sample.

ENCODING_PCM_32BIT

val ENCODING_PCM_32BIT: Int = 1073741824

PCM encoding with 32 bits per sample.

ENCODING_PCM_8BIT

val ENCODING_PCM_8BIT: Int

INDEX_UNSET

val INDEX_UNSET: Int = -1

Represents an unset or unknown index.

LENGTH_UNSET

val LENGTH_UNSET: Int = -1

Represents an unset or unknown length.

MATCH_LONGEST_US

val MATCH_LONGEST_US: Long = -2

Represents a microsecond duration whose exact value is unknown, but which should match the longest of some other known durations.

NO_VALUE

val NO_VALUE: Int = -1

A value for various fields to indicate that the field's value is unknown or not applicable.

NULL_CATALOG_ERROR

val NULL_CATALOG_ERROR: String = "Catalog object is null. A non-null Catalog object is required."

The error message for a null Catalog object

PLAYREADY_UUID

val PLAYREADY_UUID: UUID

UUID for the PlayReady DRM scheme.

POSITION_UNSET

val POSITION_UNSET: Int = -1

Represents an unset or unknown position.

SELECTION_FLAG_AUTOSELECT

val SELECTION_FLAG_AUTOSELECT: Int = 4

Indicates that the player may choose to play the track in absence of an explicit user preference.

SELECTION_FLAG_DEFAULT

val SELECTION_FLAG_DEFAULT: Int = 1

Indicates that the track should be selected if user preferences do not state otherwise.

SELECTION_FLAG_FORCED

val SELECTION_FLAG_FORCED: Int = 2

Indicates that the track must be displayed.

SELECTION_REASON_ADAPTIVE

val SELECTION_REASON_ADAPTIVE: Int = 3

A selection reason constant for an adaptive track selection.

SELECTION_REASON_INITIAL

val SELECTION_REASON_INITIAL: Int = 1

A selection reason constant for an initial track selection.

SELECTION_REASON_MANUAL

val SELECTION_REASON_MANUAL: Int = 2

A selection reason constant for an manual (i.e.

SELECTION_REASON_TRICK_PLAY

val SELECTION_REASON_TRICK_PLAY: Int = 4

A selection reason constant for a trick play track selection.

SELECTION_REASON_UNKNOWN

val SELECTION_REASON_UNKNOWN: Int = 0

A selection reason constant for selections whose reasons are unknown or unspecified.

STEREO_MODE_LEFT_RIGHT

val STEREO_MODE_LEFT_RIGHT: Int = 2

Indicates Left-Right stereo layout, used with 360/3D/VR videos.

STEREO_MODE_MONO

val STEREO_MODE_MONO: Int = 0

Indicates Monoscopic stereo layout, used with 360/3D/VR videos.

STEREO_MODE_TOP_BOTTOM

val STEREO_MODE_TOP_BOTTOM: Int = 1

Indicates Top-Bottom stereo layout, used with 360/3D/VR videos.

TIME_END_OF_SOURCE

val TIME_END_OF_SOURCE: Long = -9223372036854775808

Special constant representing a time corresponding to the end of a source.

TIME_UNSET

val TIME_UNSET: Long = -9223372036854775807

Special constant representing an unset or unknown time or duration.

UNKNOWN_TIME_US

val UNKNOWN_TIME_US: Long = -1

Represents an unknown microsecond time or duration.

VIDEO_ID_OR_REFERENCE_ID_REQUIRED

val VIDEO_ID_OR_REFERENCE_ID_REQUIRED: String = "Either a Video ID or Reference ID property is required."

The error message for missing Video ID or Reference ID

WIDEVINE_UUID

val WIDEVINE_UUID: UUID

UUID for the Widevine DRM scheme.

Functions

msToUs

open fun msToUs(timeMs: Long): Long

Converts a time in milliseconds to the corresponding time in microseconds, preserving TIME_UNSET values.

usToMs

open fun usToMs(timeUs: Long): Long

Converts a time in microseconds to the corresponding time in milliseconds, preserving TIME_UNSET values.