ArcXP-Mobile-SDK-Android/com.arcxp.video.model

Package com.arcxp.video.model

Types

AdConfig

open class AdConfig : Serializable

AdditionalProperties

@JsonClass(generateAdapter = true)

data class AdditionalProperties(val advertising: Advertising?)

AdInfo

@JsonClass(generateAdapter = true)

data class AdInfo( val adId: String, val mediaFiles: MediaFiles?, val adTitle: String, val adVerifications: List<AdVerification>, val companionAd: List<JSONObject>?, val duration: String, val durationInSeconds: Double, val startTime: String, val startTimeInSeconds: Double, val trackingEvents: List<TrackingEvent>, val clickthroughUrl: String?)

AdInsertionUrls

@JsonClass(generateAdapter = true)

data class AdInsertionUrls( val mt_master: String?, val mt_root: String?, val mt_session: String?)

Ads

@JsonClass(generateAdapter = true)

data class Ads(val ads: List<AdInfo>)

AdSettings

@JsonClass(generateAdapter = true)

data class AdSettings( val enabled: Boolean, val url: String?, val tag: String?, val encodingStatus: String?, val slate: Slate?)

AdVerification

@JsonClass(generateAdapter = true)

data class AdVerification( val javascriptResource: List<JavascriptResource>?, val vendor: String?, val verificationParameters: String?)

Advertising

@JsonClass(generateAdapter = true)

data class Advertising(val adInsertionUrls: AdInsertionUrls?, val enableAdInsertion: Boolean?)

ArcAd

class ArcAd(ad: Ad? = null)

ArcVideo

class ArcVideo( var id: String?, var uuid: String?, val startPos: Long = 0, val isYouTube: Boolean, val isLive: Boolean, _duration: Long = 0, val shareUrl: String?, val headline: String?, val pageName: String?, val videoName: String?, val videoSection: String?, val videoSource: String?, val videoCategory: String?, val contentId: String?, val fallbackUrl: String?, var adTagUrl: String?, var shouldPlayAds: Boolean, val subtitleUrl: String?, val source: Any?, val bestStream: Stream?, var autoStartPlay: Boolean, var startMuted: Boolean, var focusSkipButton: Boolean, var ccStartMode: ArcXPVideoConfig.CCStartMode = CCStartMode.DEFAULT)

ArcVideoPlaylist

@JsonClass(generateAdapter = true)

data class ArcVideoPlaylist( val playlistName: String, val version: String, val playlistItems: List<ArcVideoStream>)

ArcVideoSDKErrorType

enum ArcVideoSDKErrorType : Enum<ArcVideoSDKErrorType>

ArcVideoStream

@JsonClass(generateAdapter = true)

data class ArcVideoStream( val type: String, @Json(name = "_id") val id: String, val uuid: String?, val version: String?, @Json(name = "canonical_url") val canonicalUrl: String, @Json(name = "short_url") val shortUrl: String?, @Json(name = "created_date") val createdDate: String, @Json(name = "last_updated_date") val lastUpdatedDate: String, @Json(name = "published_date") val publishedDate: String?, @Json(name = "first_publish_date") val firstPublishDate: String, @Json(name = "display_date") val displayDate: String, val headlines: Headlines?, val subheadlines: Subheadlines?, val description: Description?, val credits: Credits?, val taxonomy: Taxonomy?, @Json(name = "additional_properties") val additionalProperties: AdditionalProperties?, val duration: Long?, @Json(name = "video_type") val videoType: String, val streams: List<Stream>, val subtitles: SubtitleUrls?, @Json(name = "promo_image") val promoImage: PromoItemBasic, var adTagUrl: String? = null, val status: String? = null)

This class holds the data for an individual video object returned from one of the ArcMediaClient API calls.

ArcVideoStreamVirtualChannel

@JsonClass(generateAdapter = true)

data class ArcVideoStreamVirtualChannel( val id: String, val name: String?, val description: String?, val websites: List<Website>?, val path: String?, val published: Boolean?, val state: String?, val url: String?, val encodingProfile: String?, val programs: List<Program>?, val adSettings: AdSettings?, val createdAt: String?, val modifiedAt: String?)

AvailList

@JsonClass(generateAdapter = true)

data class AvailList(var avails: List<VideoAdAvail>? = null)

ComputedLocation

@JsonClass(generateAdapter = true)

data class ComputedLocation( val country: String?, val zip: String?, val dma: String?)

Credits

@JsonClass(generateAdapter = true)

data class Credits(val by: List<CreditsBy>?)

CreditsBy

@JsonClass(generateAdapter = true)

data class CreditsBy( val type: String?, val name: String?, val org: String?)

Description

@JsonClass(generateAdapter = true)

data class Description(val basic: String?)

Error

@JsonClass(generateAdapter = true)

data class Error(val message: String? = null)

Headlines

@JsonClass(generateAdapter = true)

data class Headlines(val basic: String?, @Json(name = "meta_title") val metaTitle: String?)

JavascriptResource

@JsonClass(generateAdapter = true)

data class JavascriptResource(val apiFramework: String?, val uri: String?)

MediaFiles

@JsonClass(generateAdapter = true)

data class MediaFiles(val mezzanine: String, val mediaFilesList: List<JSONObject>)

Owner

@JsonClass(generateAdapter = true)

data class Owner(val name: String?)

Planning

@JsonClass(generateAdapter = true)

data class Planning(val scheduling: Scheduling?)

PostObject

@JsonClass(generateAdapter = true)

data class PostObject(val manifestUrl: String, val trackingUrl: String)

Program

@JsonClass(generateAdapter = true)

data class Program( val id: String?, val ansId: String?, val name: String?, val description: String?, val url: String?, val imageUrl: String?, val duration: Double?)

PromoItemBasic

@JsonClass(generateAdapter = true)

data class PromoItemBasic( val type: String?, val version: String?, val credits: Credits?, val url: String?, val width: Int?, val height: Int?)

PromoItems

@JsonClass(generateAdapter = true)

data class PromoItems(val basic: PromoItemBasic?)

PublishedBy

@JsonClass(generateAdapter = true)

data class PublishedBy( val email: String?, val name: String?, val lastname: String?)

Restriction

@JsonClass(generateAdapter = true)

data class Restriction( val id: String, val name: String, val restrictions: List<RestrictionItem>)

RestrictionItem

@JsonClass(generateAdapter = true)

data class RestrictionItem( val id: String, val name: String, val zips: List<String>, val dmas: List<String>, val countries: List<String>, val startTime: Int, val endTime: Int, val action: String)

Revision

@JsonClass(generateAdapter = true)

data class Revision(val published: String?)

Scheduling

@JsonClass(generateAdapter = true)

data class Scheduling(val unknown: String = "Fill in details later")

Section

@JsonClass(generateAdapter = true)

data class Section(val id: String?, val primary: Boolean)

Site

@JsonClass(generateAdapter = true)

data class Site( val type: String?, @Json(name = "_id") val id: String?, val version: String?, val name: String?, val path: String?, val primary: Boolean?)

Slate

@JsonClass(generateAdapter = true)

data class Slate( val id: String?, val filename: String?, val key: String?, val bucket: String?, val url: String?, val duration: Int)

Source

@JsonClass(generateAdapter = true)

data class Source( val name: String?, val system: String?, @Json(name = "edit_url") val editUrl: String?)

Stream

@JsonClass(generateAdapter = true)

data class Stream( val height: Int, val width: Int, val filesize: Long?, @Json(name = "stream_type") val streamType: String?, val url: String, val bitrate: Int?, val provider: String?)

Subheadlines

@JsonClass(generateAdapter = true)

data class Subheadlines(val basic: String?)

SubtitleUrl

@JsonClass(generateAdapter = true)

data class SubtitleUrl(val format: String?, val url: String?)

SubtitleUrls

@JsonClass(generateAdapter = true)

data class SubtitleUrls(val urls: List<SubtitleUrl>?)

Syndication

@JsonClass(generateAdapter = true)

data class Syndication(val search: Boolean?)

Tag

@JsonClass(generateAdapter = true)

data class Tag(val text: String)

Taxonomy

@JsonClass(generateAdapter = true)

data class Taxonomy( val tags: List<Tag>?, @Json(name = "primary_site") val primarySite: Site?, val sites: List<Site>?, @Json(name = "seo_keywords") val seoKeywords: List<String>?)

Tracking

@JsonClass(generateAdapter = true)

data class Tracking(@Json(name = "in_url_headline") val inUrlHeadline: String?)

TrackingEvent

@JsonClass(generateAdapter = true)

data class TrackingEvent( val beaconUrls: List<String>, val duration: String, val durationInSeconds: Double, val eventId: String, val eventType: String, val startTime: String, val startTimeInSeconds: Double)

TrackingType

enum TrackingType

TrackingTypeData

sealed class TrackingTypeData

TypeParams

@JsonClass(generateAdapter = true)

data class TypeParams( val country: String?, val zip: String?, val dma: String?)

VideoAdAvail

@JsonClass(generateAdapter = true)

data class VideoAdAvail( val ads: List<AdInfo>, val availId: String, val duration: String, val durationInSeconds: Double, val startTime: String, val startTimeInSeconds: Double)

VideoAdData

@JsonClass(generateAdapter = true)

data class VideoAdData( var manifestUrl: String? = null, var trackingUrl: String? = null, var adAvails: AvailList? = null, var error: Error? = null, var sessionId: String? = null)

VideoVO

@JsonClass(generateAdapter = true)

data class VideoVO( val id: String?, val adConfig: AdConfig?, val associatedContent: VideoVO.AssociatedContent?, val contentConfig: VideoVO.ContentConfig?, val customFields: Map<String, *>?, val dummy: Boolean?, val embedConfig: VideoVO.EmbedConfig?, val hideInPlaylist: Boolean?, val imageResizerUrls: List<VideoVO.ImageResizer>?, val liveEventConfig: VideoVO.LiveEventConfig?, val metaConfig: VideoVO.MetaConfig?, val platform: String?, val playlistName: String?, val producerConfig: VideoVO.ProducerConfig?, val promoImage: VideoVO.PromoImage?, val sponsoredConfig: VideoVO.SponsoredConfig?, val subtitlesConfig: VideoVO.SubtitlesConfig?, val syncContentEnabled: Boolean?, val synchronizedToMethode: Boolean?, val truthTellerEnabled: Boolean?, val variantExclusions: List<String>?)

Website

@JsonClass(generateAdapter = true)

data class Website( val id: String?, val primary: Boolean, val sections: List<Section>?)

Functions

fallback

fun ArcVideoStreamVirtualChannel.fallback(): String

fun VideoVO.fallback(): String

thumbnail

fun ArcVideoStreamVirtualChannel.thumbnail(): String

fun VideoVO.thumbnail(): String

url

fun ArcVideoStream.url(): String