Classes

The following classes are available globally.

  • Base class for all config classes.

    Declaration

    Objective-C

    
    @interface BMPConfig : NSObject <NSCopying>

    Swift

    class Config : NSObject, NSCopying
  • Base class for ad break related event classes.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdBreakEvent : BMPPlayerEvent

    Swift

    class AdBreakEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdBreakFinishedEvent : BMPAdBreakEvent

    Swift

    class AdBreakFinishedEvent : AdBreakEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdBreakStartedEvent : BMPAdBreakEvent

    Swift

    class AdBreakStartedEvent : AdBreakEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdClickedEvent : BMPPlayerEvent

    Swift

    class AdClickedEvent : PlayerEvent
  • Base class for ad related event classes.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdEvent : BMPPlayerEvent

    Swift

    class AdEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPAdFinishedEvent : BMPAdEvent

    Swift

    class AdFinishedEvent : AdEvent
  • Represents an ad which can be scheduled in the play.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdItem : NSObject <_BMPJsonable, NSCopying>

    Swift

    class AdItem : NSObject, _BMPJsonable, NSCopying
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdManifestLoadEvent : BMPPlayerEvent

    Swift

    class AdManifestLoadEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdManifestLoadedEvent : BMPPlayerEvent

    Swift

    class AdManifestLoadedEvent : PlayerEvent
  • 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.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdPricing : NSObject <_BMPJsonable>

    Swift

    class AdPricing : NSObject, _BMPJsonable
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdQuartileEvent : BMPPlayerEvent

    Swift

    class AdQuartileEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdScheduledEvent : BMPPlayerEvent

    Swift

    class AdScheduledEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPAdSkippedEvent : BMPAdEvent

    Swift

    class AdSkippedEvent : AdEvent
  • Represents an ad source which can be assigned to an AdItem. An AdItem can have multiple AdSources as waterfalling option.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdSource : NSObject <NSCopying>

    Swift

    class AdSource : NSObject, NSCopying
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdStartedEvent : BMPAdEvent

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface BMPAdSurvey : NSObject <_BMPJsonable>

    Swift

    class AdSurvey : NSObject, _BMPJsonable
  • Describes the ad system that returned the ad. Specified in InLine.AdSystem in the VAST response.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdSystem : NSObject <_BMPJsonable>

    Swift

    class AdSystem : NSObject, _BMPJsonable
  • Defines the url and type of an ad manifest.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdTag : NSObject <_BMPJsonable>

    Swift

    class AdTag : NSObject, _BMPJsonable
  • Deprecated

    Use SourceConfig(url:type:) instead.

    Base class for all adaptive media sources.

    Declaration

    Objective-C

    
    @interface BMPAdaptiveSource : BMPMediaSource

    Swift

    class AdaptiveSource : MediaSource
  • Describes he advertiser as defined by the ad serving party. Specified in InLine.Advertiser in the VAST response.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdvertiser : NSObject <_BMPJsonable>

    Swift

    class Advertiser : NSObject, _BMPJsonable
  • Contains config values regarding the ads which should be played back by the player.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdvertisingConfig : BMPConfig

    Swift

    class AdvertisingConfig : Config
  • Undocumented

    Declaration

    Objective-C

    
    @interface BMPAudioQuality : BMPQuality

    Swift

    class AudioQuality : Quality
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAudioRemovedEvent : BMPPlayerEvent

    Swift

    class AudioRemovedEvent : PlayerEvent
  • Describes an audio track.

    See more

    Declaration

    Objective-C

    
    @interface BMPAudioTrack : BMPTrack

    Swift

    class AudioTrack : Track
  • 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.

    See more

    Declaration

    Objective-C

    
    @interface BMPBitmovinCastManager : NSObject

    Swift

    class BitmovinCastManager : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    
    @interface BMPBitmovinUserInterfaceConfig : BMPUserInterfaceConfig

    Swift

    class BitmovinUserInterfaceConfig : UserInterfaceConfig
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCastAvailableEvent : BMPPlayerEvent

    Swift

    class CastAvailableEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCastPausedEvent : BMPPlayerEvent

    Swift

    class CastPausedEvent : PlayerEvent
  • A class holding information for the BMPCastWaitingForDeviceEvent.

    See more

    Declaration

    Objective-C

    
    @interface BMPCastPayload : NSObject

    Swift

    class CastPayload : NSObject
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCastPlaybackFinishedEvent : BMPPlayerEvent

    Swift

    class CastPlaybackFinishedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCastPlayingEvent : BMPPlayerEvent

    Swift

    class CastPlayingEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCastStartEvent : BMPPlayerEvent

    Swift

    class CastStartEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPCastStartedEvent : BMPPlayerEvent

    Swift

    class CastStartedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCastStoppedEvent : BMPPlayerEvent

    Swift

    class CastStoppedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPCastTimeUpdatedEvent : BMPPlayerEvent

    Swift

    class CastTimeUpdatedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPCastWaitingForDeviceEvent : BMPPlayerEvent

    Swift

    class CastWaitingForDeviceEvent : PlayerEvent
  • Represents a ClearKey config.

    See more

    Declaration

    Objective-C

    
    @interface BMPClearKeyConfig : BMPDRMConfig

    Swift

    class ClearKeyConfig : DRMConfig
  • See BMPUserInterfaceListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPControlsHideEvent : BMPPlayerEvent

    Swift

    class ControlsHideEvent : PlayerEvent
  • See BMPUserInterfaceListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPControlsShowEvent : BMPPlayerEvent

    Swift

    class ControlsShowEvent : PlayerEvent
  • Contains various data about the Creative. Specified in InLine.Creative or Wrapper.Creative in the VAST Response.

    See more

    Declaration

    Objective-C

    
    @interface BMPCreative : NSObject <_BMPJsonable>

    Swift

    class Creative : NSObject, _BMPJsonable
  • Describes a subtitle cue.

    See more

    Declaration

    Objective-C

    
    @interface BMPCue : NSObject <NSCopying>

    Swift

    class Cue : NSObject, NSCopying
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCueEnterEvent : BMPCueEvent

    Swift

    class CueEnterEvent : CueEvent
  • Base class for cue events like BMPCueEnterEvent and BMPCueExitEvent.

    See more

    Declaration

    Objective-C

    
    @interface BMPCueEvent : BMPPlayerEvent

    Swift

    class CueEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCueExitEvent : BMPCueEvent

    Swift

    class CueExitEvent : CueEvent
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCueParsedEvent : BMPCueEvent

    Swift

    class CueParsedEvent : CueEvent
  • This class handles all communication between the native environment and the Bitmovin Web UI environment in one place

    See more

    Declaration

    Objective-C

    
    @interface BMPCustomMessageHandler : NSObject

    Swift

    class CustomMessageHandler : NSObject
  • Deprecated

    Use SourceConfig(url:type:) instead.

    Represents a DASH media source.

    See more

    Declaration

    Objective-C

    
    @interface BMPDASHSource : BMPAdaptiveSource

    Swift

    class DASHSource : AdaptiveSource
  • Base class for all DRM configs.

    Note

    This class acts as an abstract class.
    See more

    Declaration

    Objective-C

    
    @interface BMPDRMConfig : BMPConfig

    Swift

    class DRMConfig : Config
  • Provides access to DRM scheme UUIDs.

    See more

    Declaration

    Objective-C

    
    @interface BMPDRMSystems : NSObject

    Swift

    class DRMSystems : NSObject
  • Represents in-playlist timed metadata.

    Note

    Only supported starting with iOS 9.3
    See more

    Declaration

    Objective-C

    
    @interface BMPDaterangeMetadata : BMPMetadata

    Swift

    class DaterangeMetadata : Metadata
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPDecryptionKey : NSObject <NSCopying, _BMPJsonable>
    /** The key identifier for the decryption key in hex string format. */
    @property (nonatomic, copy, nullable) NSString *kid;
    /** The decryption key in hex string format. */
    @property (nonatomic, copy, nonnull) NSString *key;
    /// :nodoc:
    - (instancetype)init NS_UNAVAILABLE;
    /// :nodoc:
    + (instancetype)new NS_UNAVAILABLE;
    /**
     Creates a new BMPDecryptionKey based on the given key identifier (KID) and key.
    
     @param kid The key identifier in hex string format.
     @param key The decryption key in hex string format.
     @return A new decryption key initialized with KID and key.
     */
    - (instancetype)initWithKid:(nullable NSString *)kid key:(NSString *)key NS_DESIGNATED_INITIALIZER;
    @end

    Swift

    class DecryptionKey : NSObject, NSCopying, _BMPJsonable
  • Contains config options which can be used to alter the default behaviour of content downloads.

    See more

    Declaration

    Objective-C

    
    @interface BMPDownloadConfig : BMPConfig

    Swift

    class DownloadConfig : Config
  • 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.

    See more

    Declaration

    Objective-C

    
    @interface BMPDownloadTweaksConfig : BMPConfig

    Swift

    class DownloadTweaksConfig : Config
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPDrmLicenseInformation : NSObject
    /**
     The duration in seconds how long this DRM license is valid.
     */
    @property (nonatomic, readonly) NSTimeInterval licenseDuration;
    /**
     The duration in seconds how long this DRM license is valid after playback was started for the first time.
     */
    @property (nonatomic, readonly) NSTimeInterval playbackDuration;
    /// :nodoc:
    - (instancetype)init NS_UNAVAILABLE;
    /// :nodoc:
    + (instancetype)new NS_UNAVAILABLE;
    - (instancetype)initWithLicenseDuration:(NSTimeInterval)licenseDuration
                           playbackDuration:(NSTimeInterval)playbackDuration NS_DESIGNATED_INITIALIZER;
    /**
     Returns the remaining license duration in seconds.
    
     @return the remaining license duration in seconds.
     */
    - (NSTimeInterval)remainingLicenseDuration;
    @end

    Swift

    class DrmLicenseInformation : NSObject
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPDvrWindowExceededEvent : BMPPlayerEvent

    Swift

    class DvrWindowExceededEvent : PlayerEvent
  • Represents a FairPlay Streaming DRM config.

    See more

    Declaration

    Objective-C

    
    @interface BMPFairplayConfig : BMPDRMConfig

    Swift

    class FairplayConfig : DRMConfig
  • Deprecated

    Use SourceConfig(url:type:) instead.

    Represents a HLS media source.

    See more

    Declaration

    Objective-C

    
    @interface BMPHLSSource : BMPAdaptiveSource

    Swift

    class HLSSource : AdaptiveSource
  • A config object representing an HTTP request.

    See more

    Declaration

    Objective-C

    
    @interface BMPHttpRequest : NSObject <NSCopying>

    Swift

    class HttpRequest : NSObject, NSCopying
  • Represents ID3 metadata found in the stream.

    See more

    Declaration

    Objective-C

    
    @interface BMPId3Metadata : BMPMetadata

    Swift

    class Id3Metadata : Metadata
  • Provides the possibility to overwrite the labels which are automatically assigned for different types of tracks.

    See more

    Declaration

    Objective-C

    
    @interface BMPLabelingConfig : BMPConfig

    Swift

    class LabelingConfig : Config
  • Deprecated

    Use SourceConfig(url:type:) instead.

    Base class for all media sources.

    Note

    This class acts as an abstract class.
    See more

    Declaration

    Objective-C

    
    @interface BMPMediaSource : NSObject <NSCopying>

    Swift

    class MediaSource : NSObject, NSCopying
  • Undocumented

    See more

    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
  • IMPORTANT: Methods from BMPOfflineManager need to be called from the main thread.

    This class offers functionality to handle the whole lifecycle of protected and unprotected offline content. Do not create own instances of it, instead use [OfflineManager sharedInstance] to obtain a reference to the singleton.

    Depending on the current state of the SourceConfig, which can be obtained by calling offlineStateForSourceConfig:, different methods are allowed to be called on the BMPOfflineManager. The table below shows all possible and allowed transitions between the different states. Each line describes one transition which happens immediately and synchronous. When there is a method call noted in column “Method call triggering transition”, the “Following State” is entered immediately after the method call returns.

    When there is no method call noted, the “Following State” is entered when the event described in column “BMPOfflineManagerListener event” was received.

    The “Following State” is always noted under the assumption that no error occurred when calling the transition method, or during processing of the current task. Errors are always reported to offlineManager:didFailWithError:. See the documentation of BMPOfflineManagerListener.h for more information.

    Current State Method call triggering transition BMPOfflineManagerListener event Following State
    NotDownloaded downloadSourceConfig: - Downloading
    Downloading cancelDownloadForSourceConfig: - Canceling
    Downloading suspendDownloadForSourceConfig: offlineManagerDidSuspendDownload: Suspended
    Downloading - offlineManagerDidFinishDownload: Downloaded
    Downloading - offlineManager:didProgressTo: Downloading
    Downloaded deleteOfflineDataForSourceConfig: - NotDownloaded
    Suspended resumeDownloadForSourceConfig: offlineManager:didResumeDownloadWithProgress: Downloading
    Suspended cancelDownloadForSourceConfig: - Canceling
    Canceling - offlineManagerDidCancelDownload: NotDownloaded
    Downloaded renewOfflineLicenseForSourceConfig: offlineManagerDidRenewOfflineLicense: Downloaded
    See more

    Declaration

    Objective-C

    
    @interface BMPOfflineManager : NSObject

    Swift

    class OfflineManager : NSObject
  • Represents a BMPSourceConfig which references already downloaded or currently downloading offline content. It can be passed to a BMPPlayer instance for playback. Do not create instances of this class on your own, instead use BMPOfflineManager#createOfflineSourceConfigForSourceConfig:restrictedToAssetCache:.

    See more

    Declaration

    Objective-C

    
    @interface BMPOfflineSourceConfig : BMPSourceConfig

    Swift

    class OfflineSourceConfig : SourceConfig
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPOfflineTextTrack : BMPOfflineTrack
    @property (nonatomic, copy, readonly) NSString *label;
    @property (nonatomic, copy, readonly, nullable) NSString *language;
    @property (nonatomic, readonly) BOOL isForced;
    @property (nonatomic, readonly) BOOL isDefault;
    
    - (instancetype)init NS_UNAVAILABLE;
    + (instancetype)new NS_UNAVAILABLE;
    @end

    Swift

    class OfflineTextTrack : OfflineTrack
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPOfflineTrack : NSObject
    /// :nodoc:
    @property (nonatomic, readonly) NSString *_identifier;
    @property (nonatomic) BMPOfflineTrackAction action;
    - (instancetype)init NS_UNAVAILABLE;
    + (instancetype)new NS_UNAVAILABLE;
    @end

    Swift

    class OfflineTrack : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPOfflineTrackSelection : NSObject
    @property (strong, nonatomic, readonly) NSArray<BMPOfflineTextTrack *> *textTracks;
    - (instancetype)init NS_UNAVAILABLE;
    + (instancetype)new NS_UNAVAILABLE;
    @end

    Swift

    class OfflineTrackSelection : NSObject
  • Represents a PlayReady DRM config.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayReadyConfig : BMPDRMConfig

    Swift

    class PlayReadyConfig : DRMConfig
  • Configures a new Player instance. Must not be modified after it was used to create a Player instance.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayerConfig : BMPConfig

    Swift

    class PlayerConfig : Config
  • Base class for all PlayerEvent classes.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayerEvent : NSObject <BMPEvent, _BMPJsonable>

    Swift

    class PlayerEvent : NSObject, Event, _BMPJsonable
  • Factory to create a Player instance.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayerFactory : NSObject

    Swift

    class PlayerFactory : NSObject
  • 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, or using the according property if the view is created using the interface builder.

    @discussion If you are composing the view via the interface builder make sure you use the obj-c class name BMPPlayerView

    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
              }
          }
    
    See more

    Declaration

    Objective-C

    
    @interface BMPPlayerView
        : UIView <BMPUserInterfaceApi, BMPUserInterfaceEventHandler>

    Swift

    class PlayerView : UIView, UserInterfaceApi, UserInterfaceEventHandler
  • Deprecated

    Use SourceConfig(url:type:) instead.

    Represents a progressive media source.

    See more

    Declaration

    Objective-C

    
    @interface BMPProgressiveSource : BMPMediaSource

    Swift

    class ProgressiveSource : MediaSource
  • Quality definition of a media representation.

    Note

    This class acts as an abstract class.
    See more

    Declaration

    Objective-C

    
    @interface BMPQuality : NSObject <_BMPJsonable>

    Swift

    class Quality : NSObject, _BMPJsonable
  • Represents the SCTE-35 metadata from the media playlist.

    See more

    Declaration

    Objective-C

    
    @interface BMPScteMetadata : BMPMetadata

    Swift

    class ScteMetadata : Metadata
  • Describes default properties of the custom SCTE35 tag from the playlist.

    See more

    Declaration

    Objective-C

    
    @interface BMPScteMetadataEntry : NSObject <BMPMetadataEntry>

    Swift

    class ScteMetadataEntry : NSObject, MetadataEntry
  • Represents a source config which can be played back in a player instance.

    See more

    Declaration

    Objective-C

    
    @interface BMPSourceConfig : NSObject

    Swift

    class SourceConfig : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPSourceOptions : NSObject <NSCopying, _BMPJsonable>
    /**
     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;
    
    - (instancetype)initWithStartOffset:(NSTimeInterval)startOffset
      startOffsetTimelineReferencePoint:(BMPTimelineReferencePoint)startOffsetTimelineReference NS_DESIGNATED_INITIALIZER;
    @end

    Swift

    class SourceOptions : NSObject, NSCopying, _BMPJsonable
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPSubtitleAddedEvent : BMPPlayerEvent

    Swift

    class SubtitleAddedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPSubtitleChangedEvent : BMPPlayerEvent

    Swift

    class SubtitleChangedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPSubtitleRemovedEvent : BMPPlayerEvent

    Swift

    class SubtitleRemovedEvent : PlayerEvent
  • Describes a subtitle track.

    See more

    Declaration

    Objective-C

    
    @interface BMPSubtitleTrack : BMPTrack

    Swift

    class SubtitleTrack : Track
  • Undocumented

    See more

    Declaration

    Objective-C

    
    @interface BMPSubtitleUserInterfaceConfig : BMPUserInterfaceConfig

    Swift

    class SubtitleUserInterfaceConfig : UserInterfaceConfig
  • Undocumented

    See more

    Declaration

    Objective-C

    
    @interface BMPSystemUserInterfaceConfig : BMPUserInterfaceConfig

    Swift

    class SystemUserInterfaceConfig : UserInterfaceConfig
  • Represents a VTT thumbnail.

    See more

    Declaration

    Objective-C

    
    @interface BMPThumbnail : NSObject <_BMPJsonable>

    Swift

    class Thumbnail : NSObject, _BMPJsonable
  • Describes a thumbnail track.

    See more

    Declaration

    Objective-C

    
    @interface BMPThumbnailTrack : BMPTrack

    Swift

    class ThumbnailTrack : Track
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPTimeChangedEvent : BMPPlayerEvent

    Swift

    class TimeChangedEvent : PlayerEvent
  • Base class for all available tracks.

    Note

    This class acts as an abstract class.
    See more

    Declaration

    Objective-C

    
    @interface BMPTrack : NSObject <NSCopying, _BMPJsonable>

    Swift

    class Track : NSObject, NSCopying, _BMPJsonable
  • Describes a unique creative identifier that is maintained across systems. Specified in Creative.UniversalAdId in the VAST response.

    See more

    Declaration

    Objective-C

    
    @interface BMPUniversalAdId : NSObject <_BMPJsonable>

    Swift

    class UniversalAdId : NSObject, _BMPJsonable
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPUnmutedEvent : BMPPlayerEvent

    Swift

    class UnmutedEvent : PlayerEvent
  • Undocumented

    Declaration

    Objective-C

    
    @interface BMPUserInterfaceConfig : BMPConfig

    Swift

    class UserInterfaceConfig : Config
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPVideoDownloadQualityChangedEvent : BMPPlayerEvent

    Swift

    class VideoDownloadQualityChangedEvent : PlayerEvent
  • Undocumented

    See more

    Declaration

    Objective-C

    
    @interface BMPVideoQuality : BMPQuality

    Swift

    class VideoQuality : Quality
  • See PlayerListener for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPVideoSizeChangedEvent : BMPPlayerEvent

    Swift

    class VideoSizeChangedEvent : PlayerEvent
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPVttLine : NSObject
    /**
     Defines whether the value is not present, set to auto or to an actual numeric value.
    
     Default: BMPVttLineValueTypeAuto
     */
    @property (nonatomic) BMPVttLineValueType type;
    /**
     The actual value for the line property.
    
     @note When type is set to BMPVttLineValueTypeAuto the value should be ignored.
     */
    @property (nonatomic) double value;
    - (instancetype)init NS_UNAVAILABLE;
    + (instancetype)new NS_UNAVAILABLE;
    @end

    Swift

    class VttLine : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPVttPosition : NSObject
    /**
     Defines whether the value is not present, set to auto or to an actual numeric value.
    
     Default: BMPVttPositionValueTypeAuto
    */
    @property (nonatomic) BMPVttPositionValueType type;
    /**
     The actual value for the position property.
    
     @note When type is set to BMPVttPositionValueTypeAuto the value should be ignored.
    */
    @property (nonatomic) double value;
    - (instancetype)init NS_UNAVAILABLE;
    + (instancetype)new NS_UNAVAILABLE;
    @end

    Swift

    class VttPosition : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface BMPVttProperties : NSObject
    /**
     Returns the writing direction
    
     @note: BMPVttVerticalUnset means the writing direction should be horizontal
    
     Default: BMPVttVerticalUnset
     */
    @property (nonatomic, readonly) BMPVttVertical vertical;
    /**
     Returns the vertical position of the cue box
     */
    @property (nonatomic, readonly) BMPVttLine *line;
    /**
     Returns the alignment of the line property.
    
     @discussion: See BMPVttLineAlign for more information
     */
    @property (nonatomic, readonly) BMPVttLineAlign lineAlign;
    /**
     Returns whether the line attribute should be interpreted as absolute line number or as relative position
     */
    @property (nonatomic, readonly) BOOL snapToLines;
    /**
     Returns the size of the cue box relative to the video dimensions
    
     Default: 100
    
     @note: If the writing direction is horizontal, then the size percentages are relative to the width of the video, otherwise to the height of the video
     */
    @property (nonatomic, readonly) double size;
    /**
     Returns the text alignment inside the cue box
     */
    @property (nonatomic, readonly) BMPVttAlign align;
    /**
     Returns the horizontal position of the cue box
     */
    @property (nonatomic, readonly) BMPVttPosition *position;
    /**
     Returns the alignment of the line property.
    
     Default: BMPVttPositionAlignAuto
    
     @discussion: See BMPVttPositionAlign for more information
     */
    @property (nonatomic, readonly) BMPVttPositionAlign positionAlign;
    - (instancetype)init NS_UNAVAILABLE;
    + (instancetype)new NS_UNAVAILABLE;
    @end

    Swift

    class VttProperties : NSObject
  • Represents a Widevine DRM config.

    See more

    Declaration

    Objective-C

    
    @interface BMPWidevineConfig : BMPDRMConfig

    Swift

    class WidevineConfig : DRMConfig
  • This class provides an abstraction to access the persistent data stored as key/value pairs in a single file on disk. Each instance of a _BMPPersistentArchive is associated with a single archive file and can be used to read and write its data. The _BMPPersistentArchive takes care of reading from and writing to disk internally and transparent to the object which is using the _BMPPersistentArchive.

    See more

    Declaration

    Objective-C

    
    @interface _BMPPersistentArchive : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface _BMPSegmentInfo : NSObject <_BMPStartTimeHaving>
    
    @property (assign, nonatomic, readonly) NSTimeInterval duration;
    @property (strong, nonatomic, readonly) NSString *uri;
    
    - (instancetype)initWithDuration:(NSTimeInterval)duration startTime:(NSTimeInterval)startTime uri:(NSString *)uri;
    
    @end
  • Undocumented

    See more

    Declaration

    Swift

    @objc(BMPSourceFactory)
    public class SourceFactory : NSObject
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdErrorEvent)
    public final class AdErrorEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAirPlayAvailableEvent)
    public final class AirPlayAvailableEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAirPlayChangedEvent)
    public final class AirPlayChangedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPAudioAddedEvent)
    @objcMembers
    public final class AudioAddedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAudioChangedEvent)
    public final class AudioChangedEvent : PlayerEvent
  • Provides additional data about a deficiency

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPDeficiencyData)
    public final class DeficiencyData : NSObject
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPDestroyEvent)
    public final class DestroyEvent : PlayerEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPDownloadFinishedEvent)
    @objcMembers
    public final class DownloadFinishedEvent : NSObject, SourceEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPDrmDataParsedEvent)
    @objcMembers
    public final class DrmDataParsedEvent : NSObject, SourceEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPDurationChangedEvent)
    @objcMembers
    public final class DurationChangedEvent : NSObject, SourceEvent
  • See BMPUserInterfaceListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPFullscreenDisabledEvent)
    public final class FullscreenDisabledEvent : PlayerEvent
  • See BMPUserInterfaceListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPFullscreenEnabledEvent)
    public final class FullscreenEnabledEvent : PlayerEvent
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPFullscreenEnterEvent)
    public final class FullscreenEnterEvent : PlayerEvent
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPFullscreenExitEvent)
    public final class FullscreenExitEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPMetadataEvent)
    public class MetadataEvent : PlayerEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPMetadataParsedEvent)
    public class MetadataParsedEvent : NSObject, SourceEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPMutedEvent)
    public final class MutedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPausedEvent)
    public final class PausedEvent : PlayerEvent
  • See BMPUserInterfaceListener.h for more information on this event.

    See more

    Declaration

    Swift

    public final class PictureInPictureEnterEvent : PlayerEvent
  • See BMPUserInterfaceListener.h for more information on this event.

    See more

    Declaration

    Swift

    public final class PictureInPictureEnteredEvent : PlayerEvent
  • See BMPUserInterfaceListener.h for more information on this event.

    See more

    Declaration

    Swift

    public final class PictureInPictureExitEvent : PlayerEvent
  • See BMPUserInterfaceListener.h for more information on this event.

    See more

    Declaration

    Swift

    public final class PictureInPictureExitedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPPlayEvent)
    @objcMembers
    public final class PlayEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPPlaybackFinishedEvent)
    @objcMembers
    public final class PlaybackFinishedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlayerActiveEvent)
    public final class PlayerActiveEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlayerErrorEvent)
    public final class PlayerErrorEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlayerInactiveEvent)
    public final class PlayerInactiveEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlayerWarningEvent)
    public final class PlayerWarningEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlayingEvent)
    public final class PlayingEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlaylistTransitionEvent)
    public final class PlaylistTransitionEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPReadyEvent)
    public final class ReadyEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "As this event is never emitted it will be removed in the future.")
    @objcMembers
    @objc(BMPRenderFirstFrameEvent)
    public final class RenderFirstFrameEvent : PlayerEvent
  • See BMPUserInterfaceListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPScalingModeChangedEvent)
    public final class ScalingModeChangedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSeekEvent)
    public final class SeekEvent : PlayerEvent
  • Class represent seeking position

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSeekPosition)
    public class SeekPosition : NSObject
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSeekedEvent)
    public final class SeekedEvent : PlayerEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceErrorEvent)
    public final class SourceErrorEvent : NSObject, SourceEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceLoadedEvent)
    public final class SourceLoadedEvent : NSObject, SourceEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceUnloadEvent)
    public final class SourceUnloadEvent : NSObject, SourceEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceUnloadedEvent)
    public final class SourceUnloadedEvent : NSObject, SourceEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceWarningEvent)
    public final class SourceWarningEvent : NSObject, SourceEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPStallEndedEvent)
    public final class StallEndedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPStallStartedEvent)
    public final class StallStartedEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPTimeShiftEvent)
    public final class TimeShiftEvent : PlayerEvent
  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPTimeShiftedEvent)
    public final class TimeShiftedEvent : PlayerEvent
  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceLoadEvent)
    public final class SourceLoadEvent : NSObject, SourceEvent
  • Contains config values regarding the behaviour of the bitrate adaptation.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdaptationConfig)
    public class AdaptationConfig : Config
  • Player buffer config object to configure buffering behavior.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPBufferConfig)
    public class BufferConfig : Config
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPBufferMediaTypeConfig)
    public class BufferMediaTypeConfig : Config
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPLiveConfig)
    public final class LiveConfig : Config
  • Represents an HTTP request for DRM information.

    See more

    Declaration

    Swift

    @objc(BMPDrmRequest)
    @objcMembers
    public final class DrmRequest : HttpRequest
  • The network config gives the ability to influence network requests. At the moment only changing DRM requests is supported. processing responses or influencing the retry behavior.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPNetworkConfig)
    public class NetworkConfig : Config
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlaybackConfig)
    public class PlaybackConfig : Config
  • Configures a playlist that can be loaded into a Player.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlaylistConfig)
    public final class PlaylistConfig : Config
  • Contains additional configuration options for setting up a playlist.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPPlaylistOptions)
    public final class PlaylistOptions : NSObject
  • Contains config values which can be used to alter the behaviour of the player when it comes to remote playback.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPRemoteControlConfig)
    public class RemoteControlConfig : Config
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPStyleConfig)
    public final class StyleConfig : Config
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPTweaksConfig)
    public final class TweaksConfig : Config
  • Undocumented

    See more

    Declaration

    Swift

    @objc(BMPDrmData)
    @objcMembers
    public final class DrmData : NSObject
  • Holds different information about the buffer levels.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPBufferLevel)
    public class BufferLevel : NSObject
  • Undocumented

    See more

    Declaration

    Swift

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