For AI agents: visit https://developer.bitmovin.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
PlaybackPlayback
HomeDocumentationRecipesAPI Reference
Bitmovin PlatformPlaybackEncodingBitmovin DashboardPlayback
API Reference
Bitmovin PlatformPlaybackEncodingBitmovin Dashboard
HomeDocumentationRecipesAPI Reference

PLAYER API REFERENCE

  • Overview
  • Player Web SDK
    • Working with event handlers
  • Player Android SDK
    • v3 API Reference (Android SDK)
    • Errors & Warnings Overview
    • Events Overview
    • Migration Guide - v2 to v3 (Android SDK)
    • [Unsupported] v2 API Reference (Android SDK)
  • Player iOS, tvOS SDK
    • v3 API Reference (iOS SDK)
    • [Unsupported] v2 API Reference (iOS SDK)
    • Migration Guide - v2 to v3 (iOS SDK)
  • Player Roku SDK
  • Player Flutter SDK
  • Player React Native SDK
  • Player UI Framework
    • Migration Guide - v3 to v4 (Bitmovin Player UI)

Analytics Collector API Reference

  • iOS/tvOS Analytics Collector

Observability API Reference

  • Exports
    • List Export Tasksget
    • Create Export Taskpost
    • Get export taskget
  • Impressions
    • List impressionspost
    • Impression Detailspost
    • Ads Impressionspost
    • Impression Error Detailspost
  • Insights
    • Get the current organization settings for industry insightsget
    • Update the organization settings for industry insightsput
  • Metrics
    • Get metrics datapost
    • Get metrics datapost
    • Get metrics datapost
  • Ads
    • Countpost
    • Sumpost
    • Avgpost
    • Minpost
    • Maxpost
    • Stddevpost
    • Percentilepost
    • Variancepost
    • Medianpost
  • Queries
    • Countpost
    • Sumpost
    • Avgpost
    • Minpost
    • Maxpost
    • Stddevpost
    • Percentilepost
    • Variancepost
    • Medianpost
  • Licenses
    • List Analytics Licensesget
    • Create Analytics Licensepost
    • Get Licenseget
    • Update Analytics Licenseput
    • List License Domainsget
    • Add Domainpost
    • Delete Domaindel
  • Virtual-licenses
    • Create Analytics Virtual Licensepost
    • List Analytics Virtual Licensesget
    • Analytics Virtual Licenseget
    • Update Analytics Virtual Licenseput
    • Delete Analytics Virtual Licensedel
  • Outputs
    • List Microsoft Azure Outputsget
    • Create Microsoft Azure Outputpost
    • Microsoft Azure Output Detailsget
    • Delete Microsoft Azure Outputdel
    • Azure Output Custom Dataget
    • List S3 Role-based Outputsget
    • Create S3 Role-based Outputpost
    • S3 Role-based Output Detailsget
    • Delete S3 Role-based Outputdel
    • S3 Role-based Output Custom Dataget
    • List Service Account based GCS Outputsget
    • Create Service Account based GCS Outputpost
    • Service Account based GCS Output Detailsget
    • Delete Service Account based GCS Outputdel
    • Service Account based GCS Output Custom Dataget

Player Web SDK - API Reference

  • Player
    • PlayerAPI
    • Player Configuration
    • Source Configuration
  • Events
    • Events
    • Event Types
  • Streaming
    • Adaptation & ABR
    • Buffer API
    • Network API
  • Advertising
    • Advertising
    • Advertising - Bitmovin Module
    • Advertising - IMA Module
  • Features
    • Analytics
    • DRM
    • Subtitles
    • VR
    • Remote Control
    • Server-Guided Ad Insertion
  • Reference
    • Error Handling
    • Modules
    • Utilities
    • Full TypeDoc Reference

player-android-sdk-api-reference

  • player
    • com.bitmovin.player.api.media.session
      • MediaSessionSourceConfig
    • com.bitmovin.player.api
      • PlayerBuilder
    • com.bitmovin.player.api.source
      • SourceBuilder
  • player-analytics
    • com.bitmovin.player.api.analytics
      • AnalyticsApi
      • AnalyticsPlayerConfig
      • AnalyticsSourceConfig
      • PlayerFactory
      • SourceAnalyticsApi
      • SourceFactory
  • player-core
    • com.bitmovin.player.api.advertising.bitmovin
      • BitmovinAdvertisingConfig
    • com.bitmovin.player.api.advertising.ima
      • ImaAdBreak
      • ImaAdBreakConfig
      • ImaAdData
      • ImaAdTagConfig
      • ImaConfig
      • ImaUiElement
      • ImaUiType
    • com.bitmovin.player.api.advertising.interstitials
      • CustomAttributesMappingHandler
      • InterstitialAdBreak
      • InterstitialCustomAttributesMappingRegistry
      • InterstitialMappingData
      • InterstitialsConfig
    • com.bitmovin.player.api.advertising.interstitials.tracking.macro
      • InterstitialMacro
      • InterstitialMacroValueProvider
    • com.bitmovin.player.api.advertising.interstitials.tracking
      • CustomAttributesMappingPresets
      • InterstitialTrackingEvent
      • InterstitialTrackingEventTrigger
      • InterstitialTrackingRegistry
    • com.bitmovin.player.api.advertising
      • Ad
      • AdBreak
      • AdBreakConfig
      • AdConfig
      • AdData
      • AdItem
      • AdQuartile
      • AdSource
      • AdSourceType
      • AdTag
      • AdTagConfig
      • AdTagType
      • AdsManagerAvailableCallback
      • AdvertisingApi
      • AdvertisingConfig
      • BeforeInitializationCallback
      • CompanionAdContainer
      • LinearAd
      • LinearAdUiConfig
      • OverlayAd
      • SeekedOverContext
      • ShouldLoadAdItemCallback
      • ShouldPlayAdBreakCallback
      • ShouldPlaySeekedOverAdItemsCallback
    • com.bitmovin.player.api.advertising.vast.macro
      • VastMacro
      • VastMacroConfig
      • VastMacroContext
      • VastMacroScope
      • VastMacroValueProvider
    • com.bitmovin.player.api.advertising.vast
      • AdPricing
      • AdQualitySelectionContext
      • AdSurvey
      • AdSystem
      • Advertiser
      • Creative
      • MediaFile
      • MediaFileDeliveryType
      • OnSelectAdQuality
      • UniversalAdId
      • VastAdData
      • VastAdExtension
    • com.bitmovin.player.api.buffer
      • BufferApi
      • BufferConfig
      • BufferLevel
      • BufferMediaTypeConfig
      • BufferType
    • com.bitmovin.player.api.casting
      • ConfigureMediaInfoCallback
      • GoogleCastMediaInfoConfig
      • GoogleCastMediaType
      • RemoteControlApi
      • RemoteControlConfig
    • com.bitmovin.player.api.decoder
      • DecoderConfig
      • DecoderPriorityProvider
      • MediaCodecInfo
    • com.bitmovin.player.api.deficiency.exception
      • DrmLicenseKeyExpiredException
      • DrmSessionException
      • EmptyPlaylistException
      • IllegalOperationException
      • LicenseKeyMissingException
      • NoConnectionException
      • UnsupportedDrmException
    • com.bitmovin.player.api.deficiency
      • DeficiencyCode
      • DeficiencyData
      • ErrorCode
      • ErrorEvent
      • OfflineErrorCode
      • OfflineWarningCode
      • PlayerErrorCode
      • PlayerWarningCode
      • SourceErrorCode
      • SourceWarningCode
      • WarningCode
      • WarningEvent
    • com.bitmovin.player.api.drm
      • ClearKeyConfig
      • ClearKeyConfigEntry
      • DrmConfig
      • DrmData
      • DrmRequest
      • NagraConnectConfig
      • PlayReadyConfig
      • PrepareLicenseCallback
      • PrepareMessageCallback
      • WidevineConfig
    • com.bitmovin.player.api.event.data
      • AnalyticsLicenseData
      • CastPayload
      • ImpressionData
      • LicenseData
      • PeriodData
      • SeekPosition
    • com.bitmovin.player.api.event
      • Event
      • EventEmitter
      • EventListener
      • InfoEvent
      • JavaEventEmitter
      • OfflineEvent
      • PlayerEvent
      • SourceEvent
    • com.bitmovin.player.api.live
      • LiveConfig
      • LiveSynchronizationMethod
      • LowLatencyApi
      • LowLatencyConfig
      • LowLatencySynchronizationConfig
      • ProducerReferenceTimeInfo
      • SourceLiveConfig
      • SynchronizationConfigEntry
      • TargetPlaybackLatencyCallback
      • TargetSynchronizationConfig
    • com.bitmovin.player.api.logging
      • LoggingEventConfig
    • com.bitmovin.player.api.media.audio
      • AudioLabeler
      • AudioTrack
    • com.bitmovin.player.api.media.audio.quality
      • AudioQuality
      • AudioQualityLabeler
    • com.bitmovin.player.api.media
      • AdaptationConfig
      • AdaptationData
      • LabelingConfig
      • MediaFilter
      • MediaTrackRole
      • MediaType
      • MimeTypes
      • Quality
      • Track
      • TrackType
    • com.bitmovin.player.api.media.subtitle
      • Cue
      • ForcedSubtitleCallback
      • SubtitleLabeler
      • SubtitleTrack
      • SubtitleTrackController
    • com.bitmovin.player.api.media.thumbnail
      • Thumbnail
      • ThumbnailTrack
    • com.bitmovin.player.api.media.video.quality
      • VideoAdaptation
      • VideoAdaptationData
      • VideoQuality
      • VideoQualityLabeler
      • DynamicRange
    • com.bitmovin.player.api.metadata.daterange
      • DateRangeMetadata
    • com.bitmovin.player.api.metadata.emsg
      • EventMessage
    • com.bitmovin.player.api.metadata.id3
      • ApicFrame
      • BinaryFrame
      • ChapterFrame
      • ChapterTocFrame
      • CommentFrame
      • GeobFrame
      • Id3Frame
      • PrivFrame
      • TextInformationFrame
      • UrlLinkFrame
    • com.bitmovin.player.api.metadata
      • Metadata
    • com.bitmovin.player.api.metadata.scte
      • ScteMessage
    • com.bitmovin.player.api.network
      • HttpRequest
      • HttpRequestType
      • HttpResponse
      • NetworkConfig
      • PreprocessHttpRequestCallback
      • PreprocessHttpResponseCallback
      • RetryHttpRequestConfig
    • com.bitmovin.player.api.offline.options
      • AudioOfflineOptionEntry
      • OfflineContentOptions
      • OfflineOptionEntry
      • OfflineOptionEntryAction
      • OfflineOptionEntryState
      • TextOfflineOptionEntry
      • ThumbnailOfflineOptionEntry
      • VideoOfflineOptionEntry
    • com.bitmovin.player.api.offline
      • DeviceStateRequirement
      • DrmLicenseInformation
      • OfflineConfig
      • OfflineContentManager
      • OfflineContentManagerListener
      • OfflineErrorEvent
      • OfflineSourceConfig
      • OfflineTweaksConfig
      • ResourceIdentifierCallback
    • com.bitmovin.player.api
      • BandwidthEstimationMode
      • BandwidthMeterType
      • DebugConfig
      • DeviceDescription
      • ExperimentalBitmovinApi
      • ForceReuseVideoCodecReason
      • HlsConfig
      • LicensingConfig
      • LoadErrorFallbackConfig
      • PlaybackConfig
      • Player
      • PlayerConfig
      • SeekMode
      • TimeRange
      • TweaksConfig
    • com.bitmovin.player.api.playlist
      • PlaylistApi
      • PlaylistConfig
      • PlaylistOptions
      • ReplayMode
      • SeekTarget
    • com.bitmovin.player.api.recovery
      • RetryPlaybackAction
      • RetryPlaybackCallback
      • RetryPlaybackConfig
      • RetryPlaybackContext
    • com.bitmovin.player.api.source
      • AdaptiveSource
      • CmcdConfig
      • CmcdKey
      • CmcdSessionId
      • CmcdTransmissionMode
      • DASHSource
      • HLSSource
      • LoadingState
      • MediaSource
      • NetworkEngine
      • ProgressiveSource
      • SmoothSource
      • Source
      • SourceAdaptationConfig
      • SourceConfig
      • SourceNetworkConfig
      • SourceOptions
      • SourceType
      • TimelineReferencePoint
    • com.bitmovin.player.api.ui.notification
      • CustomActionReceiver
      • MediaDescriptionAdapter
      • NotificationListener
    • com.bitmovin.player.api.ui
      • ScalingMode
      • StyleConfig
    • com.bitmovin.player.api.vr.orientation
      • OrientationProvider
      • Vector3
      • ViewingDirection
    • com.bitmovin.player.api.vr
      • VrApi
      • VrConfig
      • VrContentType
      • VrRenderer
      • VrViewingWindowConfig
    • com.bitmovin.player.casting
      • BitmovinCastManager
      • BitmovinCastOptionsProvider
      • ExpandedControllerActivity
    • com.bitmovin.player.offline.service
      • BitmovinDownloadService
      • BitmovinDownloadState
    • com.bitmovin.player
      • CaptionStyle
      • SubtitleRendererView
      • SubtitleView
    • com.bitmovin.player.ui.notification
      • DefaultMediaDescriptor
      • PlayerNotificationManager
    • com.bitmovin.player.util
      • ParcelUtil
    • com.bitmovin.player.api.ssai
      • SsaiAd
      • SsaiAdBreak
      • SsaiApi
      • SsaiMetadata
  • player-media-session
    • com.bitmovin.player.api.media.session
      • ControllerInfo
      • MediaMetadata
      • MediaSession
      • MediaSessionBuilder
      • MediaSessionService
      • Rating
  • player-ui-web
    • com.bitmovin.player.api.ui
      • FullscreenHandler
      • PictureInPictureHandler
      • PlayerViewConfig
      • SurfaceType
      • UiConfig
      • UserInterfaceApi
    • com.bitmovin.player
      • PlayerView
  • player-ui-web-compose
    • com.bitmovin.player.api.ui.compose.wrapper
Powered by 

iOS/tvOS Analytics Collector

Bitmovin Analytics iOS/tvOS Collector API Reference

iOS/tvOS Analytics Collector API Reference v3

Updated 6 months ago


Migration Guide - v3 to v4 (Bitmovin Player UI)
Exports
Did this page help you?

Updated 6 months ago


Migration Guide - v3 to v4 (Bitmovin Player UI)
Exports
Did this page help you?
    • iOS/tvOS Analytics Collector API Reference v3