Classes Reference


                    
                    
                    BMPAdPricing

Used to provide a value that represents a price that can be used by real-time bidding (RTB) systems. Specified in Inline.Pricing in the VAST response.

Declaration

Objective-C


@interface BMPAdPricing : NSObject <_BMPJsonEncodable>

Swift

class AdPricing : NSObject, _JsonEncodable


                    
                    
                    BMPAdSurvey

A string representation of a URI to any resource relating to an integrated survey. Specified in InLine.Survey in the VAST response.

Declaration

Objective-C


@interface BMPAdSurvey : NSObject <_BMPJsonEncodable>

Swift

class AdSurvey : NSObject, _JsonEncodable


                    
                    
                    BMPAdSystem

Describes the ad system that returned the ad. Specified in InLine.AdSystem in the VAST response.

Declaration

Objective-C


@interface BMPAdSystem : NSObject <_BMPJsonEncodable>

Swift

class AdSystem : NSObject, _JsonEncodable


                    
                    
                    BMPAdTag

Defines the url and type of an ad manifest.

Declaration

Objective-C


@interface BMPAdTag : NSObject <_BMPJsonEncodable>

Swift

class AdTag : NSObject, _JsonEncodable


                    
                    
                    BMPAdvertiser

Describes he advertiser as defined by the ad serving party. Specified in InLine.Advertiser in the VAST response.

Declaration

Objective-C


@interface BMPAdvertiser : NSObject <_BMPJsonEncodable>

Swift

class Advertiser : NSObject, _JsonEncodable


                    
                    
                    BMPBitmovinCastManager

IMPORTANT: Methods from BMPBitmovinCastManager need to be called from the main thread.

Singleton providing access to GoogleCast related features. The BMPBitmovinCastManager needs to be initialized by calling BMPBitmovinCastManager#initializeCasting in the AppDelegate of the application which should support casting.

Declaration

Objective-C


@interface BMPBitmovinCastManager : NSObject

Swift

class BitmovinCastManager : NSObject


                    
                    
                    BMPCreative

Contains various data about the Creative. Specified in InLine.Creative or Wrapper.Creative in the VAST Response.

Declaration

Objective-C


@interface BMPCreative : NSObject <_BMPJsonEncodable>

Swift

class Creative : NSObject, _JsonEncodable


                    
                    
                    BMPHttpRequest

A config object representing an HTTP request.

Declaration

Objective-C


@interface BMPHttpRequest : NSObject <NSCopying>

Swift

class HttpRequest : NSObject, NSCopying, @unchecked Sendable


                    
                    
                    BMPId3Metadata

Represents ID3 metadata found in the stream.

Declaration

Objective-C


@interface BMPId3Metadata : BMPMetadata

Swift

class Id3Metadata : Metadata


                    
                    
                    BMPMetadata

Undocumented

Declaration

Objective-C

@interface BMPMetadata : NSObject
@property (nonatomic, readonly, copy) NSArray<id<BMPMetadataEntry>> *entries;
- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;
- (instancetype)initWithEntries:(NSArray<id<BMPMetadataEntry>> *)entries NS_DESIGNATED_INITIALIZER;
@end

Swift

class Metadata : NSObject


                    
                    
                    BMPPlayerCoreFactory

Factory to create a BMPPlayer instance.

Declaration

Objective-C


@interface BMPPlayerCoreFactory : NSObject


                    
                    
                    BMPPlayerFactory

Factory to create a Player instance.

Declaration

Objective-C


@interface BMPPlayerFactory : NSObject


                    
                    
                    BMPScteMetadata

Represents the SCTE-35 metadata from the media playlist.

Declaration

Objective-C


@interface BMPScteMetadata : BMPMetadata

Swift

class ScteMetadata : Metadata


                    
                    
                    BMPSourceOptions

Undocumented

Declaration

Objective-C

@interface BMPSourceOptions : NSObject <NSCopying, _BMPJsonEncodable>
/**
 The position where the stream should be started. Number can be positive or negative depending on the used TimelineReferencePoint.
 Invalid numbers will be corrected according to the stream boundaries.
 For VOD this is applied at the time the stream is loaded, for LIVE when the playback starts.

 Default: NAN
 */
@property (nonatomic) NSTimeInterval startOffset;
/**
 Timeline reference point to calculate BMPSourceOptions.startOffset from.

 Default for live: BMPTimelineReferencePointEnd
 Default for VOD: BMPTimelineReferencePointStart
 */
@property (nonatomic) BMPTimelineReferencePoint startOffsetTimelineReference;
/**
 The identifier for the `SourceConfig` in a SharePlay session.
 This identifier is used:
 - to validate that received SharePlay commands are intended for the currently active `Source`'s `SourceConfig` when receiving them.
 - for caching the playback state within the SharePlay session
   If there is a stored playback state for the given identifier, it will be applied when a `SourceConfig` with the same identifier becomes active.

 @note The identifier must match for all participants in the SharePlay session.
 If no identifier is provided, the URL of the `SourceConfig` will be used.
 */
@property (nonatomic, nullable, copy) NSString *sharePlayIdentifier;

- (instancetype)initWithStartOffset:(NSTimeInterval)startOffset
  startOffsetTimelineReferencePoint:(BMPTimelineReferencePoint)startOffsetTimelineReference;
- (instancetype)initWithStartOffset:(NSTimeInterval)startOffset
  startOffsetTimelineReferencePoint:(BMPTimelineReferencePoint)startOffsetTimelineReference
                sharePlayIdentifier:(nullable NSString *)sharePlayIdentifier NS_DESIGNATED_INITIALIZER;
@end

Swift

class SourceOptions : NSObject, NSCopying, _JsonEncodable, @unchecked Sendable


                    
                    
                    BMPThumbnail

Represents a VTT thumbnail.

Declaration

Objective-C


@interface BMPThumbnail : NSObject <_BMPJsonEncodable>

Swift

class Thumbnail : NSObject, _JsonEncodable


                    
                    
                    BMPUniversalAdId

Describes a unique creative identifier that is maintained across systems. Specified in Creative.UniversalAdId in the VAST response.

Declaration

Objective-C


@interface BMPUniversalAdId : NSObject <_BMPJsonEncodable>

Swift

class UniversalAdId : NSObject, _JsonEncodable


                    
                    
                    BMPAnalyticsPlayerConfig

Configuration for the analytics data collection feature on the BMPPlayer.

Declaration

Objective-C


@interface BMPAnalyticsPlayerConfig : NSObject


                    
                    
                    PlayerFactory

Factory to create a Player instance.

Declaration

Swift

@available(iOS 14.0, tvOS 14.0, *)
public class PlayerFactory : @unchecked Sendable


                    
                    
                    SourceFactory

Factory to create Sources which can be loaded into a Player.

Declaration

Swift

@available(iOS 14.0, tvOS 14.0, *)
@objc(BMPSourceFactory)
public class SourceFactory : NSObject, @unchecked Sendable


                    
                    
                    LatencyApi

Provides the means to manage latency for live-streams. Accessible through Player.latency.

Note

Disable PlayerConfig.tweaksConfig.isCustomHlsLoadingEnabled when intending to play HLS-LL streams below iOS and tvOS 17. Due to platform limitations, HLS-LL streams are not supported there while this property is enabled.

This API is not supported during casting.

Declaration

Swift

@objcMembers
@objc(BMPLatencyApi)
public class LatencyApi : NSObject


                    
                    
                    SharePlayApi

The Obj-C version of the SharePlay API. It is empty on purpose as SharePlay can only be used from Swift.

Declaration

Swift

@objc(BMPSharePlayApi)
public class SharePlayApi : NSObject


                    
                    
                    ThumbnailsApi

Provides the means to interact and manage thumbnails. Accessible through Player.thumbnails.

This API is not supported during casting.

Declaration

Swift

@objcMembers
@objc(BMPThumbnailsApi)
public class ThumbnailsApi : NSObject


                    
                    
                    PlayerEventsApi

The Obj-C version of the player events API. It is empty on purpose as Combine-based event subscriptions can only be used from Swift.

Declaration

Swift

@objc(BMPPlayerEventsApi)
public class PlayerEventsApi : NSObject


                    
                    
                    PlayerViewEventsApi

The Obj-C version of the player view events API. It is empty on purpose as Combine-based event subscriptions can only be used from Swift.

Declaration

Swift

@MainActor
@objc(BMPPlayerViewEventsApi)
public class PlayerViewEventsApi : NSObject


                    
                    
                    SourceEventsApi

The Obj-C version of the source events API. It is empty on purpose as Combine-based event subscriptions can only be used from Swift.

Declaration

Swift

@objc(BMPSourceEventsApi)
public class SourceEventsApi : NSObject


                    
                    
                    AdBreakEvent

Base class for ad break related event classes.

Declaration

Swift

@objcMembers
@objc(BMPAdBreakEvent)
open class AdBreakEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AdBreakFinishedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdBreakFinishedEvent)
open class AdBreakFinishedEvent : AdBreakEvent, @unchecked Sendable


                    
                    
                    AdBreakStartedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdBreakStartedEvent)
open class AdBreakStartedEvent : AdBreakEvent, @unchecked Sendable


                    
                    
                    AdClickedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdClickedEvent)
open class AdClickedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AdErrorEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdErrorEvent)
open class AdErrorEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AdEvent

Base class for ad related event classes.

Declaration

Swift

@objcMembers
@objc(BMPAdEvent)
open class AdEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AdFinishedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdFinishedEvent)
open class AdFinishedEvent : AdEvent, @unchecked Sendable


                    
                    
                    AdManifestLoadEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdManifestLoadEvent)
open class AdManifestLoadEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AdManifestLoadedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdManifestLoadedEvent)
open class AdManifestLoadedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AdQuartileEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPAdQuartileEvent)
@objcMembers
open class AdQuartileEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AdScheduledEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPAdScheduledEvent)
@objcMembers
open class AdScheduledEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AdSkippedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdSkippedEvent)
open class AdSkippedEvent : AdEvent, @unchecked Sendable


                    
                    
                    AdStartedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdStartedEvent)
open class AdStartedEvent : AdEvent, @unchecked Sendable


                    
                    
                    AirPlayAvailabilityChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAirPlayAvailabilityChangedEvent)
public class AirPlayAvailabilityChangedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AirPlayAvailableEvent

See PlayerListener for more information on this event.

Declaration

Swift

@available(*, deprecated, renamed: "AirPlayAvailabilityChangedEvent(allowsAirPlay:﹚")
@objcMembers
@objc(BMPAirPlayAvailableEvent)
public class AirPlayAvailableEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AirPlayChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAirPlayChangedEvent)
public class AirPlayChangedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    AudioAddedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPAudioAddedEvent)
@objcMembers
public class AudioAddedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    AudioChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAudioChangedEvent)
public class AudioChangedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    AudioRemovedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAudioRemovedEvent)
public class AudioRemovedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    CastAvailableEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPCastAvailableEvent)
@objcMembers
open class CastAvailableEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CastPausedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPCastPausedEvent)
@objcMembers
open class CastPausedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CastPlaybackFinishedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPCastPlaybackFinishedEvent)
@objcMembers
open class CastPlaybackFinishedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CastPlayingEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPCastPlayingEvent)
@objcMembers
open class CastPlayingEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CastStartEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPCastStartEvent)
@objcMembers
open class CastStartEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CastStartedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPCastStartedEvent)
@objcMembers
open class CastStartedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CastStoppedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPCastStoppedEvent)
@objcMembers
open class CastStoppedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CastTimeUpdatedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPCastTimeUpdatedEvent)
@objcMembers
open class CastTimeUpdatedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CastWaitingForDeviceEvent

See PlayerListener for more information on this event.

Declaration

Swift

@available(tvOS, unavailable)
@objc(BMPCastWaitingForDeviceEvent)
@objcMembers
open class CastWaitingForDeviceEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    CueEnterEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPCueEnterEvent)
open class CueEnterEvent : PlayerEvent, CueEvent, @unchecked Sendable


                    
                    
                    CueExitEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPCueExitEvent)
open class CueExitEvent : PlayerEvent, CueEvent, @unchecked Sendable


                    
                    
                    CueParsedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPCueParsedEvent)
open class CueParsedEvent : NSObject, CueEvent, SourceEvent, @unchecked Sendable


                    
                    
                    DeficiencyData

Provides additional data about a deficiency

Declaration

Swift

@objcMembers
@objc(BMPDeficiencyData)
public class DeficiencyData : NSObject


                    
                    
                    DestroyEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPDestroyEvent)
public class DestroyEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    DownloadFinishedEvent

See SourceListener for more information on this event.

Declaration

Swift

@objc(BMPDownloadFinishedEvent)
@objcMembers
public class DownloadFinishedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    DrmDataParsedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPDrmDataParsedEvent)
@objcMembers
public class DrmDataParsedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    DurationChangedEvent

See SourceListener for more information on this event.

Declaration

Swift

@objc(BMPDurationChangedEvent)
@objcMembers
public class DurationChangedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    DvrWindowExceededEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPDvrWindowExceededEvent)
@objcMembers
open class DvrWindowExceededEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    LicenseValidatedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPLicenseValidatedEvent)
@objcMembers
open class LicenseValidatedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    MetadataEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPMetadataEvent)
public class MetadataEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    MetadataParsedEvent

See SourceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPMetadataParsedEvent)
public class MetadataParsedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    MutedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPMutedEvent)
public class MutedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    OutputObscuredEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPOutputObscuredEvent)
public class OutputObscuredEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    OutputUnobscuredEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPOutputUnobscuredEvent)
public class OutputUnobscuredEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PausedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPPausedEvent)
public class PausedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlayEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPPlayEvent)
@objcMembers
public class PlayEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlaybackFinishedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPPlaybackFinishedEvent)
@objcMembers
public class PlaybackFinishedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlaybackSpeedChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPPlaybackSpeedChangedEvent)
public class PlaybackSpeedChangedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlayerActiveEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPPlayerActiveEvent)
public class PlayerActiveEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlayerErrorEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPPlayerErrorEvent)
public class PlayerErrorEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlayerEvent

Base class for all PlayerEvent classes.

Declaration

Swift

@objc(BMPPlayerEvent)
@objcMembers
open class PlayerEvent : NSObject, Event, @unchecked Sendable


                    
                    
                    PlayerInactiveEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPPlayerInactiveEvent)
public class PlayerInactiveEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlayerWarningEvent

See PlayerListener for more information on this event.

Declaration

Swift

@available(*, deprecated, message: "Warnings are now communicated through logs with level `.warning`. These logs are printed to the console by default. You can also access them by providing your own logger to `DebugConfig.logging.logger`\"")
@objcMembers
@objc(BMPPlayerWarningEvent)
public class PlayerWarningEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlayingEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPPlayingEvent)
public class PlayingEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    PlaylistTransitionEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPPlaylistTransitionEvent)
public class PlaylistTransitionEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    ReadyEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPReadyEvent)
public class ReadyEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SeekEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSeekEvent)
public class SeekEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SeekPosition

Class represent seeking position

Declaration

Swift

@objcMembers
@objc(BMPSeekPosition)
public class SeekPosition : NSObject


                    
                    
                    SeekedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSeekedEvent)
public class SeekedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SharePlayEndedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@available(iOS 15.0, tvOS 15.0, *)
@objc(BMPSharePlayEndedEvent)
@objcMembers
public class SharePlayEndedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SharePlayStartedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@available(iOS 15.0, tvOS 15.0, *)
@objc(BMPSharePlayStartedEvent)
@objcMembers
public class SharePlayStartedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SharePlaySuspensionEndedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@available(iOS 15.0, tvOS 15.0, *)
@objc(BMPSharePlaySuspensionEndedEvent)
@objcMembers
public class SharePlaySuspensionEndedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SharePlaySuspensionStartedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@available(iOS 15.0, tvOS 15.0, *)
@objc(BMPSharePlaySuspensionStartedEvent)
@objcMembers
public class SharePlaySuspensionStartedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SourceAddedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPSourceAddedEvent)
@objcMembers
public class SourceAddedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SourceErrorEvent

See SourceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSourceErrorEvent)
public class SourceErrorEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    SourceLoadedEvent

See SourceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSourceLoadedEvent)
public class SourceLoadedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    SourceRemovedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPSourceRemovedEvent)
@objcMembers
public class SourceRemovedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SourceUnloadEvent

See SourceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSourceUnloadEvent)
public class SourceUnloadEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    SourceUnloadedEvent

See SourceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSourceUnloadedEvent)
public class SourceUnloadedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    SourceWarningEvent

See SourceListener for more information on this event.

Declaration

Swift

@available(*, deprecated, message: "Warnings are now communicated through logs with level `.warning`. These logs are printed to the console by default. You can also access them by providing your own logger to `DebugConfig.logging.logger`\"")
@objcMembers
@objc(BMPSourceWarningEvent)
public class SourceWarningEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    StallEndedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPStallEndedEvent)
public class StallEndedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    StallStartedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPStallStartedEvent)
public class StallStartedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    SubtitleAddedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPSubtitleAddedEvent)
@objcMembers
open class SubtitleAddedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    SubtitleChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPSubtitleChangedEvent)
@objcMembers
open class SubtitleChangedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    SubtitleRemovedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPSubtitleRemovedEvent)
@objcMembers
open class SubtitleRemovedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    TimeChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPTimeChangedEvent)
open class TimeChangedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    TimeShiftEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPTimeShiftEvent)
public class TimeShiftEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    TimeShiftedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPTimeShiftedEvent)
public class TimeShiftedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    UnmutedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPUnmutedEvent)
@objcMembers
open class UnmutedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    VideoDownloadQualityChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPVideoDownloadQualityChangedEvent)
@objcMembers
public class VideoDownloadQualityChangedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    VideoPlaybackQualityChangedEvent

See SourceListener for more information on this event.

Declaration

Swift

@objc(BMPVideoPlaybackQualityChangedEvent)
@objcMembers
public class VideoPlaybackQualityChangedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    VideoSizeChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPVideoSizeChangedEvent)
open class VideoSizeChangedEvent : PlayerEvent, @unchecked Sendable


                    
                    
                    ControlsHideEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objc(BMPControlsHideEvent)
@objcMembers
open class ControlsHideEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    ControlsShowEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objc(BMPControlsShowEvent)
@objcMembers
open class ControlsShowEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    FullscreenDisabledEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPFullscreenDisabledEvent)
public class FullscreenDisabledEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    FullscreenEnabledEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPFullscreenEnabledEvent)
public class FullscreenEnabledEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    FullscreenEnterEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPFullscreenEnterEvent)
public class FullscreenEnterEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    FullscreenExitEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPFullscreenExitEvent)
public class FullscreenExitEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    PictureInPictureEnterEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

public class PictureInPictureEnterEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    PictureInPictureEnteredEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

public class PictureInPictureEnteredEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    PictureInPictureExitEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

public class PictureInPictureExitEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    PictureInPictureExitedEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

public class PictureInPictureExitedEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    ScalingModeChangedEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPScalingModeChangedEvent)
public class ScalingModeChangedEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    TimelineMarkerEnterEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPTimelineMarkerEnterEvent)
public class TimelineMarkerEnterEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    TimelineMarkerExitEvent

See UserInterfaceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPTimelineMarkerExitEvent)
public class TimelineMarkerExitEvent : NSObject, PlayerViewEvent, @unchecked Sendable


                    
                    
                    FairplayLicenseAcquiredEvent

See SourceListener for more information on this event.

Declaration

Swift

@objc(BMPFairplayLicenseAcquiredEvent)
@objcMembers
public class FairplayLicenseAcquiredEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    SourceLoadEvent

See SourceListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSourceLoadEvent)
public class SourceLoadEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    LogEntry

Represents one single log entry

Declaration

Swift

@objc(BMPLogEntry)
@objcMembers
public final class LogEntry : NSObject


                    
                    
                    CastPayload

A class holding information for the CastWaitingForDeviceEvent.

Declaration

Swift

@available(tvOS, unavailable)
@objc(BMPCastPayload)
@objcMembers
public final class CastPayload : NSObject


                    
                    
                    BitmovinCastManagerOptions

The options to be used for initializing BitmovinCastManager

Declaration

Swift

@objcMembers
@objc(BMPBitmovinCastManagerOptions)
public final class BitmovinCastManagerOptions : NSObject


                    
                    
                    DebugConfig

Contains config values to help debugging the SDK.

Declaration

Swift

@objcMembers
@objc(BMPDebugConfig)
public final class DebugConfig : NSObject, @unchecked Sendable


                    
                    
                    LoggingConfig

This component enables configuration of logging globally in the SDK through assigning a logger.

Logging can be configured through the assigned logger in multiple ways. By setting the logger to nil logging can be disabled. A minimum log level is also set in the assigned logger. The minimum log level is used to filter log output.

The default value for the logger is an instance of ConsoleLogger. Instead of the ConsoleLogger, a custom logger can be assigned for receiving log entries. A custom logger would need to apply its own filtering based on level. This level-based filtering is applied by default in the ConsoleLogger.

To configure logging, access this config via DebugConfig.logging. Refer to Logger, LogLevel, LogEntry, ConsoleLogger and DebugConfig for more details.

Declaration

Swift

@objcMembers
@objc(BMPLoggingConfig)
public final class LoggingConfig : NSObject, @unchecked Sendable


                    
                    
                    NowPlayingConfig

Configures the current Now Playing information for the application. This information will be displayed wherever Now Playing information typically appears, such as the lock screen and inside the control center.

Declaration

Swift

@objcMembers
@objc(BMPNowPlayingConfig)
public class NowPlayingConfig : NSObject, @unchecked Sendable


                    
                    
                    PlayerConfig

Configures a new Player instance. Must not be modified after it was used to create a Player instance.

Declaration

Swift

@objc(BMPPlayerConfig)
@objcMembers
public final class PlayerConfig : NSObject, @unchecked Sendable


                    
                    
                    AdaptationConfig

Contains config values regarding the behaviour of the bitrate adaptation.

Declaration

Swift

@objcMembers
@objc(BMPAdaptationConfig)
public class AdaptationConfig : NSObject, @unchecked Sendable


                    
                    
                    AdItem

Represents an ad break which can be scheduled for playback.

Declaration

Swift

@objc(BMPAdItem)
@objcMembers
public class AdItem : NSObject, @unchecked Sendable


                    
                    
                    AdSource

Represents an ad source which can be assigned to an AdItem. An AdItem can have multiple AdSources as a waterfalling option.

Declaration

Swift

@objc(BMPAdSource)
@objcMembers
public class AdSource : NSObject, @unchecked Sendable

extension AdSource: NSCopying


                    
                    
                    AdvertisingConfig

Contains config values regarding the ads which should be played back by the player.

Declaration

Swift

@objc(BMPAdvertisingConfig)
@objcMembers
public class AdvertisingConfig : NSObject, @unchecked Sendable


                    
                    
                    LinearAdUiConfig

Configuration object for the LinearAd UI.

In case Bitmovin Player UI is used, message placeholders such as: {remainingTime}, {adDuration} or {playedTime} are available to customize the ad messages. When using the System UI, only {remainingTime} is supported.

Example:

let linearAdUiConfig = LinearAdUiConfig()
linearAdUiConfig.message = "This ad will end in {remainingTime}"
linearAdUiConfig.untilSkippableMessage = "This ad is skippable in {remainingTime}"
linearAdUiConfig.skippableMessage = "You can skip this ad now."

// Create an `AdItem` with one `AdSource` of type `.bitmovin`
let adItem = AdItem(
   adSources: [AdSource(tag: adTagUrl, ofType: .bitmovin)],
   // Configure the ad as a pre-roll ad
   atPosition: "pre",
   // Provide a LinearAdUiConfig instance to customize the ad UI messages
   linearAdUiConfig: linearAdUiConfig
)

Declaration

Swift

@objc(BMPLinearAdUiConfig)
@objcMembers
public class LinearAdUiConfig : NSObject, @unchecked Sendable


                    
                    
                    BitmovinAdvertisingConfig

Contains configuration options to customize behavior for Bitmovin Advertising Module integration.

Declaration

Swift

@objc(BMPBitmovinAdvertisingConfig)
@objcMembers
public class BitmovinAdvertisingConfig : NSObject, @unchecked Sendable


                    
                    
                    VastMacro

Represents a VAST macro for VastMacroValueProvider.

Declaration

Swift

@objc(BMPVastMacro)
public class VastMacro : NSObject, @unchecked Sendable


                    
                    
                    VastMacroConfig

Contains configuration options for VAST macros.

Declaration

Swift

@objc(BMPVastMacroConfig)
@objcMembers
public class VastMacroConfig : NSObject, @unchecked Sendable


                    
                    
                    ImaAdAttributionUiMode

Defines the IMA Ad attribution UI mode

Declaration

Swift

@available(tvOS, unavailable)
@objcMembers
@objc(BMPImaAdAttributionUiMode)
public class ImaAdAttributionUiMode : NSObject, @unchecked Sendable


                    
                    
                    ImaAdvertisingConfig

Contains configuration options to customize behavior for Google IMA SDK.

Declaration

Swift

@objcMembers
@objc(BMPImaAdvertisingConfig)
public class ImaAdvertisingConfig : NSObject, @unchecked Sendable


                    
                    
                    ImaSettings

The ImaSettings class stores SDK wide settings.

Declaration

Swift

@objc(BMPImaSettings)
@objcMembers
public class ImaSettings : NSObject, NSCopying, @unchecked Sendable


                    
                    
                    BufferConfig

Player buffer config object to configure buffering behavior.

Declaration

Swift

@objcMembers
@objc(BMPBufferConfig)
public class BufferConfig : NSObject, @unchecked Sendable


                    
                    
                    BufferMediaTypeConfig

Configures buffer target levels for different MediaTypes.

Declaration

Swift

@objcMembers
@objc(BMPBufferMediaTypeConfig)
public class BufferMediaTypeConfig : NSObject, @unchecked Sendable


                    
                    
                    LiveConfig

Contains config values regarding the behaviour when playing live streams.

Declaration

Swift

@available(*, deprecated, message: "Configuration for live streams has moved to the source-based `SourceLiveConfig`. Use `SourceConfig.liveConfig` instead.")
@objcMembers
@objc(BMPLiveConfig)
public final class LiveConfig : NSObject, @unchecked Sendable


                    
                    
                    DrmRequest

Represents an HTTP request for DRM information.

Declaration

Swift

@objc(BMPDrmRequest)
@objcMembers
public final class DrmRequest : HttpRequest, @unchecked Sendable


                    
                    
                    HttpResponse

Represents an HTTP response.

Declaration

Swift

@objc(BMPHttpResponse)
@objcMembers
public final class HttpResponse : NSObject, @unchecked Sendable


                    
                    
                    NetworkConfig

The network config gives the ability to influence network requests.

Declaration

Swift

@objcMembers
@objc(BMPNetworkConfig)
public class NetworkConfig : NSObject, @unchecked Sendable


                    
                    
                    PlaybackConfig

Contains config values that can be used to alter the playback behaviour of the player.

Declaration

Swift

@objcMembers
@objc(BMPPlaybackConfig)
public class PlaybackConfig : NSObject, @unchecked Sendable


                    
                    
                    RemoteControlConfig

Contains config values which can be used to alter the behaviour of the player when it comes to remote playback.

Declaration

Swift

@available(visionOS, unavailable)
@objcMembers
@objc(BMPRemoteControlConfig)
public class RemoteControlConfig : NSObject, @unchecked Sendable


                    
                    
                    BitmovinUserInterfaceConfig

Contains config values that can be used to alter the visual presentation and behaviour when the Bitmovin Player Web UI is used.

Declaration

Swift

@objcMembers
@objc(BMPBitmovinUserInterfaceConfig)
public class BitmovinUserInterfaceConfig : UserInterfaceConfig, @unchecked Sendable


                    
                    
                    BitmovinUserInterfaceMetadata

Contains metadata values to act as a fallback when respective values are not defined for the currently active source. See individual properties for details.

Declaration

Swift

@objcMembers
@objc(BMPBitmovinUserInterfaceMetadata)
public class BitmovinUserInterfaceMetadata : NSObject, @unchecked Sendable


                    
                    
                    StyleConfig

Contains config values which can be used to alter the visual presentation and behaviour of the player UI.

Declaration

Swift

@objcMembers
@objc(BMPStyleConfig)
public final class StyleConfig : NSObject, @unchecked Sendable


                    
                    
                    SubtitleUserInterfaceConfig

Contains config values that can be used to alter the visual presentation and behaviour when the subtitle only UI is used.

Declaration

Swift

@objcMembers
@objc(BMPSubtitleUserInterfaceConfig)
public class SubtitleUserInterfaceConfig : UserInterfaceConfig, @unchecked Sendable


                    
                    
                    SystemUserInterfaceConfig

Contains config values that can be used to alter the visual presentation and behaviour when the System UI is used.

Declaration

Swift

@objcMembers
@objc(BMPSystemUserInterfaceConfig)
public class SystemUserInterfaceConfig : UserInterfaceConfig, @unchecked Sendable


                    
                    
                    UserInterfaceConfig

Declaration

Swift

@objcMembers
@objc(BMPUserInterfaceConfig)
public class UserInterfaceConfig : NSObject, @unchecked Sendable


                    
                    
                    TweaksConfig

This configuration is used as an incubator for experimental features. Tweaks are not officially supported and are not guaranteed to be stable, i.e. their naming, functionality and API can change at any time within the tweaks or when being promoted to an official feature and moved into its final configuration namespace.

Declaration

Swift

@objcMembers
@objc(BMPTweaksConfig)
public final class TweaksConfig : NSObject, @unchecked Sendable


                    
                    
                    PlayerViewConfig

Configures a new PlayerView instance.

Declaration

Swift

@objcMembers
@objc(BMPPlayerViewConfig)
public class PlayerViewConfig : NSObject, @unchecked Sendable


                    
                    
                    PictureInPictureConfig

Provides options to configure Picture in Picture playback.

Declaration

Swift

@objcMembers
@objc(BMPPictureInPictureConfig)
public class PictureInPictureConfig : NSObject, @unchecked Sendable


                    
                    
                    PlaylistConfig

Configures a playlist that can be loaded into a Player.

Declaration

Swift

@objcMembers
@objc(BMPPlaylistConfig)
public final class PlaylistConfig : NSObject, @unchecked Sendable


                    
                    
                    PlaylistOptions

Contains additional configuration options for setting up a playlist.

Declaration

Swift

@objcMembers
@objc(BMPPlaylistOptions)
public final class PlaylistOptions : NSObject, @unchecked Sendable


                    
                    
                    InterstitialMarker

Marks the time range of an interstitial for the asset when presented in the tvOS system UI. Only supported when StyleConfig.userInterfaceType = .system is used! An interstitial could be an advertisement, legal notice, or content warning. The time range defined by an InterstitialMarker is visually collapsed from the presentation, affecting rendered duration and playback time. The values returned by player.duration and player.currentTime remain unaffected.


                    
                    
                    LabelingConfig

Provides the possibility to overwrite the labels which are automatically assigned for different types of tracks.

Declaration

Swift

@objcMembers
@objc(BMPLabelingConfig)
public class LabelingConfig : NSObject, @unchecked Sendable


                    
                    
                    SourceConfig

Represents a source config which can be played back in a player instance.

Declaration

Swift

@objcMembers
@objc(BMPSourceConfig)
open class SourceConfig : NSObject, @unchecked Sendable


                    
                    
                    SourceLiveConfig

Contains config values regarding the behaviour when playing live streams.

Note

Disable PlayerConfig.tweaksConfig.isCustomHlsLoadingEnabled when intending to play HLS-LL streams below iOS and tvOS 17. Due to platform limitations, HLS-LL streams are not supported there while this property is enabled.

Declaration

Swift

@objcMembers
@objc(BMPSourceLiveConfig)
public class SourceLiveConfig : NSObject, @unchecked Sendable


                    
                    
                    ClearKeyConfig

Represents a ClearKey config.

Declaration

Swift

@objcMembers
@objc(BMPClearKeyConfig)
public final class ClearKeyConfig : DrmConfig, @unchecked Sendable


                    
                    
                    DecryptionKey

Represents a decryption key for a ClearKey DRM config

Declaration

Swift

@objcMembers
@objc(BMPDecryptionKey)
public final class DecryptionKey : NSObject, NSCopying, @unchecked Sendable


                    
                    
                    DrmConfig

Base class for all DRM configs.

Note

This class acts as an abstract class.

Declaration

Swift

@objcMembers
@objc(BMPDrmConfig)
public class DrmConfig : NSObject, @unchecked Sendable


                    
                    
                    DrmSystems

Provides access to DRM scheme UUIDs.

Declaration

Swift

@objcMembers
@objc(BMPDrmSystems)
public final class DrmSystems : NSObject, @unchecked Sendable


                    
                    
                    FairplayConfig

Represents a FairPlay Streaming DRM config.

Declaration

Swift

@objcMembers
@objc(BMPFairplayConfig)
public class FairplayConfig : DrmConfig, @unchecked Sendable


                    
                    
                    PlayReadyConfig

Represents a PlayReady DRM config.

Declaration

Swift

@objcMembers
@objc(BMPPlayReadyConfig)
public final class PlayReadyConfig : DrmConfig, @unchecked Sendable


                    
                    
                    WidevineConfig

Represents a Widevine DRM config.

Declaration

Swift

@objcMembers
@objc(BMPWidevineConfig)
public final class WidevineConfig : DrmConfig, @unchecked Sendable


                    
                    
                    AudioTrack

Describes an audio track.

Declaration

Swift

@objcMembers
@objc(BMPAudioTrack)
public class AudioTrack : Track, @unchecked Sendable

Cue

Describes a subtitle cue.

Declaration

Swift

@objcMembers
@objc(BMPCue)
public class Cue : NSObject, NSCopying, @unchecked Sendable


                    
                    
                    CuePosition

Positioning information for CEA captions

Declaration

Swift

@objcMembers
@objc(BMPCuePosition)
public class CuePosition : NSObject, @unchecked Sendable


                    
                    
                    SubtitleTrack

Describes a subtitle track.

Declaration

Swift

@objcMembers
@objc(BMPSubtitleTrack)
public class SubtitleTrack : Track, @unchecked Sendable


                    
                    
                    ThumbnailTrack

Describes a thumbnail track.

Declaration

Swift

@objcMembers
@objc(BMPThumbnailTrack)
public class ThumbnailTrack : Track, @unchecked Sendable


                    
                    
                    Track

Base class for all available tracks.

Note

This class acts as an abstract class.

Declaration

Swift

@objcMembers
@objc(BMPTrack)
public class Track : NSObject, @unchecked Sendable


                    
                    
                    ConsoleLogger

Prints a log entry to the console when logging is enabled in the SDK, and the log entry level equals or is above the minimum log level that is assigned to level below. See LogEntry and LoggingConfig for more details.

Declaration

Swift

@objcMembers
@objc(BMPConsoleLogger)
public class ConsoleLogger : NSObject, Logger


                    
                    
                    AnalyticsLicenseData

Contains analytics specific data returned from the license server.

Declaration

Swift

@objc(BMPAnalyticsLicenseData)
@objcMembers
public class AnalyticsLicenseData : NSObject


                    
                    
                    DaterangeMetadata

Represents in-playlist timed metadata.

Declaration

Swift

@objcMembers
@objc(BMPDaterangeMetadata)
public class DaterangeMetadata : Metadata


                    
                    
                    DrmData

Declaration

Swift

@objc(BMPDrmData)
@objcMembers
public final class DrmData : NSObject


                    
                    
                    FairplayContentKeyRequest

Represents a FairPlay content key request. This object can be used for renewing expiring licenses via Source.drm.fairplay.renewExpiringLicense API

Declaration

Swift

@objc(BMPFairplayContentKeyRequest)
@objcMembers
public class FairplayContentKeyRequest : NSObject


                    
                    
                    LicenseData

Contains additional license data returned from the license server.

Declaration

Swift

@objc(BMPLicenseData)
@objcMembers
public class LicenseData : NSObject


                    
                    
                    ScteMetadataEntry

Describes default properties of the custom SCTE35 tag from the playlist.

Declaration

Swift

@objcMembers
@objc(BMPScteMetadataEntry)
public final class ScteMetadataEntry : NSObject, MetadataEntry


                    
                    
                    BufferLevel

Holds different information about the buffer levels.

Declaration

Swift

@objcMembers
@objc(BMPBufferLevel)
open class BufferLevel : NSObject


                    
                    
                    SourceDrmApi

Provides the means to manage DRM on a Source. Accessible through Source.drm.

Declaration

Swift

@objc(BMPSourceDrmApi)
@objcMembers
public class SourceDrmApi : NSObject


                    
                    
                    SourceDrmFairplayApi

Provides the means to manage FairPlay DRM on a Source. Accessible through Source.drm.fairplay.

Declaration

Swift

@objc(BMPSourceDrmFairplayApi)
@objcMembers
public class SourceDrmFairplayApi : NSObject


                    
                    
                    Quality

Quality definition of a media representation.

Note: This class acts as an abstract class.

Declaration

Swift

@objcMembers
@objc(BMPQuality)
public class Quality : NSObject


                    
                    
                    VideoQuality

Quality definition of a video representation.

Declaration

Swift

@objcMembers
@objc(BMPVideoQuality)
public class VideoQuality : Quality


                    
                    
                    VttLine

Declaration

Swift

@objc(BMPVttLine)
@objcMembers
public final class VttLine : NSObject


                    
                    
                    VttPosition

Declaration

Swift

@objc(BMPVttPosition)
@objcMembers
public final class VttPosition : NSObject


                    
                    
                    VttProperties

Declaration

Swift

@objc(BMPVttProperties)
@objcMembers
public final class VttProperties : NSObject


                    
                    
                    DownloadConfig

Contains config options which can be used to alter the default behaviour of content downloads.

Declaration

Swift

@objc(BMPDownloadConfig)
@objcMembers
public final class DownloadConfig : NSObject, @unchecked Sendable


                    
                    
                    DownloadTweaksConfig

This config is used as an incubator for experimental features. Tweaks are not officially supported and are not guaranteed to be stable, i.e. their naming, functionality and API can change at any time within the tweaks or when being promoted to an official feature and moved into its final config namespace.

Declaration

Swift

@objc(BMPDownloadTweaksConfig)
@objcMembers
public final class DownloadTweaksConfig : NSObject, @unchecked Sendable


                    
                    
                    OfflineManager

Declaration

Swift

@objcMembers
@objc(BMPOfflineManager)
public class OfflineManager : NSObject, @unchecked Sendable


                    
                    
                    DrmLicenseInformation

Holds DRM licence information

Declaration

Swift

@objcMembers
@objc(BMPDrmLicenseInformation)
public class DrmLicenseInformation : NSObject


                    
                    
                    OfflineConfig

Configures the offline functionality

Declaration

Swift

@objc(BMPOfflineConfig)
@objcMembers
public final class OfflineConfig : NSObject, @unchecked Sendable


                    
                    
                    OfflineSourceConfig

Represents a SourceConfig which references already downloaded or currently downloading offline content. It can passed to a Player instance for playback. Do not create instances of this class on your own, instead use OfflineContentManager.createOfflineSourceConfig(restrictedToAssetCache:).

Declaration

Swift

@objcMembers
@objc(BMPOfflineSourceConfig)
public class OfflineSourceConfig : SourceConfig, @unchecked Sendable


                    
                    
                    OfflineAudioTrack

Declaration

Swift

@objc(BMPOfflineAudioTrack)
@objcMembers
public final class OfflineAudioTrack : OfflineTrack


                    
                    
                    OfflineTextTrack

Represents a text track which can be selected to download for offline playback

Declaration

Swift

@objc(BMPOfflineTextTrack)
@objcMembers
public final class OfflineTextTrack : OfflineTrack


                    
                    
                    OfflineTrack

Superclass of tracks which can be selected to download for offline playback

Declaration

Swift

@objc(BMPOfflineTrack)
@objcMembers
public class OfflineTrack : NSObject


                    
                    
                    OfflineTrackSelection

Represents the information which tracks to download for offline playback

Declaration

Swift

@objc(BMPOfflineTrackSelection)
@objcMembers
public final class OfflineTrackSelection : NSObject


                    
                    
                    SourceLatencyApi

Provides the means to manage latency for a live-stream on a Source. Accessible through Source.latency.

Note

Disable PlayerConfig.tweaksConfig.isCustomHlsLoadingEnabled when intending to play HLS-LL streams below iOS and tvOS 17. Due to platform limitations, HLS-LL streams are not supported there while this property is enabled.

Declaration

Swift

@objc(BMPSourceLatencyApi)
@objcMembers
public class SourceLatencyApi : NSObject


                    
                    
                    SourceMetadataChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPSourceMetadataChangedEvent)
@objcMembers
public class SourceMetadataChangedEvent : NSObject, SourceEvent, @unchecked Sendable


                    
                    
                    PlayerView

A view that provides the Bitmovin Player UI and default UI handling to an attached Player instance. This view needs a Player instance to work properly. This Player can be passed to the initializer.

If a custom UI is preferred, an AVPlayerLayer or an AVPlayerViewController can be registered via registerPlayerLayer / registerPlayerViewController. See PlayerView for more details.

// Create a subclass of UIView
class CustomView: UIView {
    init(player: Player, frame: CGRect) {
        super.init(frame: frame)

        // register the AVPlayerLayer of this view to the Player
        player.register(playerLayer)
    }

    var playerLayer: AVPlayerLayer {
        layer as! AVPlayerLayer
    }

    override class var layerClass: AnyClass {
        AVPlayerLayer.self
    }
}

Declaration

Swift

@available(iOS 14.0, tvOS 14.0, *)
@MainActor
@objcMembers
@objc(BMPPlayerView)
open class PlayerView : UIView

extension PlayerView: UIScrollViewDelegate

extension PlayerView: UserInterfaceApi

extension PlayerView: UserInterfaceEventHandler

extension PlayerView: _PlayerListenerInternal


                    
                    
                    CustomMessageHandler

This class handles all communication between the native environment and the Bitmovin Web UI environment in one place.

Declaration

Swift

@objcMembers
@objc(BMPCustomMessageHandler)
public class CustomMessageHandler : NSObject, @unchecked Sendable


                    
                    
                    VastMacroContext

Context for VAST macro replacement.

Declaration

Swift

@objc(BMPVastMacroContext)
@objcMembers
public class VastMacroContext : NSObject


                    
                    
                    BitmovinCastManagerOptions

The options to be used for initializing BitmovinCastManager


                    
                    
                    BitmovinUserInterfaceConfig

Contains config values that can be used to alter the visual presentation and behaviour when the Bitmovin Player Web UI is used.


                    
                    
                    InterstitialMarker

Marks the time range of an interstitial for the asset when presented in the tvOS system UI. Only supported when StyleConfig.userInterfaceType = .system is used! An interstitial could be an advertisement, legal notice, or content warning. The time range defined by an InterstitialMarker is visually collapsed from the presentation, affecting rendered duration and playback time. The values returned by player.duration and player.currentTime remain unaffected.

Declaration

Swift

public class InterstitialMarker : TimelineMarker, @unchecked Sendable


                    
                    
                    DownloadConfig

Contains config options which can be used to alter the default behaviour of content downloads.


                    
                    
                    DownloadTweaksConfig

This config is used as an incubator for experimental features. Tweaks are not officially supported and are not guaranteed to be stable, i.e. their naming, functionality and API can change at any time within the tweaks or when being promoted to an official feature and moved into its final config namespace.


                    
                    
                    OfflineConfig

Configures the offline functionality


                    
                    
                    OfflineSourceConfig

Represents a SourceConfig which references already downloaded or currently downloading offline content. It can passed to a Player instance for playback. Do not create instances of this class on your own, instead use OfflineContentManager.createOfflineSourceConfig(restrictedToAssetCache:).


                    
                    
                    OfflineAudioTrack


                    
                    
                    OfflineTextTrack

Represents a text track which can be selected to download for offline playback


                    
                    
                    OfflineTrack

Superclass of tracks which can be selected to download for offline playback


                    
                    
                    OfflineTrackSelection

Represents the information which tracks to download for offline playback


                    
                    
                    CustomMessageHandler

This class handles all communication between the native environment and the Bitmovin Web UI environment in one place.


                    
                    
                    PlayerAnalyticsApiAccessor

Provides an ObjC way of accessing the Analytics namespace for a given Player instance.

Declaration

Swift

@objcMembers
@objc(BPAPlayerAnalyticsApiAccessor)
public class PlayerAnalyticsApiAccessor : NSObject, @unchecked Sendable


                    
                    
                    SourceAnalyticsApiAccessor

Provides an ObjC way of accessing the Analytics namespace for a given Source instance.

Declaration

Swift

@objcMembers
@objc(BPASourceAnalyticsApiAccessor)
public class SourceAnalyticsApiAccessor : NSObject, @unchecked Sendable