fl-foundation/com.quickplay.vstb7.util

Package-level declarations

Types

Holds callbacks that will be triggered for specific Application lifecycle events.

object AppProcessLifecycleObserver : LifecycleEventObserver

Application's LifecycleObserver that notifies registered AppLifecycleEventCallbacks when the Application is coming to the foreground or going to the background.

SideEffect

typealias SideEffect = () -> Unit

Type that Represents a SideEffect for particular Transition

State

data class State<TState : Enum<TState>>(val valueMap: Map<TState, State<*>>)

The State information on State Machine

StateMachine

class StateMachine<TContext : Any, TState : Enum<TState>, TEvent : Any>

Every StateMachine has a UNIQUE parent State ENUM among it's Peers

TransitionHandler

typealias TransitionHandler<TContext, TState, TEvent> = (context: TContext, state: TState, event: TEvent) -> TransitionInfo<TState>?

Type that represents a lambda that processes all the Transitions for a particular StateMachine

TransitionInfo

data class TransitionInfo<TState : Enum<TState>>(val value: TState, val sideEffect: SideEffect = EMPTY_SIDE_EFFECT)

Represents the New State and Side Effect pair for any transition

VASTAd

data class VASTAd(val title: String, val errorURI: String?, val impressionTrackingURLs: List<String>, val videoDuration: String?, val videoMediaFiles: List<VASTMediaFile>, val videoClickThroughURL: String?, val videoClickTrackingURLs: List<String>, val companions: List<VASTCompanion>, val vastAdTagURL: String?)

Representation of VAST document's element.

VASTAdParser

object VASTAdParser

VASTCompanion

data class VASTCompanion(val companionWidth: Int, val companionHeight: Int, val companionResourceURI: String?, val companionAltText: String?, val companionClickThroughURL: String?, val companionClickTrackingURL: String?, val companionAPIFramework: String?)

Representation of VAST document's element.

VASTMediaFile

data class VASTMediaFile(val videoWidth: Int, val videoHeight: Int, val videoDeliveryProtocol: String?, val videoMimeType: String?, val videoMediaFileURL: String?)

Representation of VAST document's element.

WebVTTThumbnailMetadata

data class WebVTTThumbnailMetadata(val thumbnailTimeRange: LongRange, val thumbnailURL: String)

Represents a thumbnail metadata

WebVTTThumbnailMetadataParser

object WebVTTThumbnailMetadataParser

Properties

MOBILE_DEVICE

const val MOBILE_DEVICE: String

TABLET_DEVICE

const val TABLET_DEVICE: String

TV_DEVICE

const val TV_DEVICE: String

VAST_DOCUMENT_PARSING_FAILURE

const val VAST_DOCUMENT_PARSING_FAILURE: Int = 3842

Indicates that the VAST document parsing failed.

VAST_DOCUMENT_RETRIEVAL_FAILURE

const val VAST_DOCUMENT_RETRIEVAL_FAILURE: Int = 3841

Indicates that the network request to fetch VAST document failed.

WEBVTT_DOCUMENT_RETRIEVAL_FAILURE

const val WEBVTT_DOCUMENT_RETRIEVAL_FAILURE: Int = 3585

Indicates that the network request to fetch WebVTT document failed.

WEBVTT_EXTENDED_TIME_FORMAT

const val WEBVTT_EXTENDED_TIME_FORMAT: String

WEBVTT_EXTENDED_TIME_FORMAT_PATTERN

const val WEBVTT_EXTENDED_TIME_FORMAT_PATTERN: String

WEBVTT_HEADER

const val WEBVTT_HEADER: String

WEBVTT_TIME_FORMAT

const val WEBVTT_TIME_FORMAT: String

Functions

computeDiskCacheDir

fun computeDiskCacheDir(applicationContext: Context, directory: String): File

Creates a subdirectory, under existing platform cache designated directory, that is used for caching data related to a specific usage context(images, http responses etc). The logic tries to use the external storage (sdcard) path but if not mounted, falls back on the internal storage.

computeDisplayDimensions

fun computeDisplayDimensions(): Pair<Int, Int>

Computes device display dimensions.

convertToResult

fun <T : Any, R : Any> convertToResult(data: T? = null, error: R? = null): Result<T, R>

Wraps a passed data (or) error into appropriate Result object. Note: Only one param is expected to be passed.

customBinarySearch

fun customBinarySearch(positionMs: Long, thumbnails: List<WebVTTThumbnailMetadata>): Int

Searches, using the binary search algorithm, the collection of WebVTTThumbnailMetadata objects to find a thumbnail URL that matches a given time position in a stream.

decodeBase64

fun String.decodeBase64(): ByteArray?

Extension to decode a given Base64 String to ByteArray

epochTimeToIso8601UTCDate

fun epochTimeToIso8601UTCDate(epochTime: Long): String

formatTimeInHHMMSS

fun formatTimeInHHMMSS(timeMs: Long): String

getApplicationContext

@UiThread

fun getApplicationContext(): Context

getAttributeValue

fun getAttributeValue(xpp: XmlPullParser, attributeName: String): String?

Returns the value of an attribute of the current start tag.

getAttributeValueIgnorePrefix

fun getAttributeValueIgnorePrefix(xpp: XmlPullParser, attributeName: String): String?

Returns the value of an attribute of the current start tag. Any raw attribute names in the current start tag have their prefixes stripped before matching.

getCacheQuota

fun getCacheQuota(applicationContext: Context, diskCacheDir: File): Long?

Returns the recommended amount of maximum disk space that can be used by the application to perform the caching logic.

getDeviceType

@UiThread

fun getDeviceType(): String

Determines the type of Android device the application is running on.

getDoubleAttributeValue

fun getDoubleAttributeValue(xpp: XmlPullParser, attributeName: String): Double

Returns the Double value of an attribute of the current start tag.

getFloatAttributeValue

fun getFloatAttributeValue(xpp: XmlPullParser, attributeName: String): Float

Returns the Float value of an attribute of the current start tag.

getIntAttributeValue

fun getIntAttributeValue(xpp: XmlPullParser, attributeName: String): Int

Returns the Int value of an attribute of the current start tag.

getLongAttributeValue

fun getLongAttributeValue(xpp: XmlPullParser, attributeName: String): Long

Returns the Long value of an attribute of the current start tag.

getText

fun getText(xpp: XmlPullParser): String?

Returns the character data if the current event matches the TEXT event.

getThumbnailURL

fun getThumbnailURL(positionMs: Long, thumbnails: List<WebVTTThumbnailMetadata>): String?

Searches the collection of WebVTTThumbnailMetadata objects to find a thumbnail URL that matches a given time position in a stream.

isEndTag

fun isEndTag(xpp: XmlPullParser): Boolean

Returns whether the current event is an end tag.

fun isEndTag(xpp: XmlPullParser, name: String): Boolean

Returns whether the current event is an end tag with the specified name.

isEndTagIgnorePrefix

fun isEndTagIgnorePrefix(xpp: XmlPullParser, name: String): Boolean

Returns whether the current event is an end tag with the specified name. If the current event has a raw name then its prefix is stripped before matching.

iso8601UTCDateToEpochTime

fun iso8601UTCDateToEpochTime(iso8601Date: String): Long

isStartTag

fun isStartTag(xpp: XmlPullParser): Boolean

Returns whether the current event is a start tag.

fun isStartTag(xpp: XmlPullParser, name: String): Boolean

Returns whether the current event is a start tag with the specified name.

isStartTagIgnorePrefix

fun isStartTagIgnorePrefix(xpp: XmlPullParser, name: String): Boolean

Returns whether the current event is a start tag with the specified name. If the current event has a raw name then its prefix is stripped before matching.

isWebVTTHeaderLine

fun isWebVTTHeaderLine(webVTTThumbnailContent: String): Boolean

Returns whether the given input is the first line of a WebVTT file.

maybeSkipTag

fun maybeSkipTag(xpp: XmlPullParser)

If the provided XmlPullParser is currently positioned at the start of a tag, skips forward to the end of that tag.

stackTraceString

fun Throwable.stackTraceString(): String

Returns the Stack-Trace of a Throwable as String

toBase64

fun ByteArray.toBase64(): String

Extension to encode a given Byte Array to Base64 String

fun String.toBase64(charset: Charset = Charsets.UTF_8): String

Extension to encode a given Charsets.UTF_8 string to Base64