Classes

The following classes are available globally.

  • 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
  • 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 BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdQuartileEvent : BMPPlayerEvent

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface BMPAdScheduledEvent : BMPPlayerEvent

    Swift

    class AdScheduledEvent : PlayerEvent
  • 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
  • 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
  • Contains configuration values regarding the behaviour of the bitrate adaptation.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdaptationConfiguration : NSObject <BMPJsonable>

    Swift

    class AdaptationConfiguration : NSObject, BMPJsonable
  • 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 configuration values regarding the ads which should be played back by the player.

    See more

    Declaration

    Objective-C

    
    @interface BMPAdvertisingConfiguration : BMPConfiguration

    Swift

    class AdvertisingConfiguration : Configuration
  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPAirPlayAvailableEvent : BMPPlayerEvent

    Swift

    class AirPlayAvailableEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAirPlayChangedEvent : BMPPlayerEvent

    Swift

    class AirPlayChangedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPAudioChangedEvent : BMPPlayerEvent

    Swift

    class AudioChangedEvent : PlayerEvent
  • Undocumented

    Declaration

    Objective-C

    
    @interface BMPAudioQuality : BMPQuality

    Swift

    class AudioQuality : Quality
  • See BMPPlayerListener.h 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
  • This class represents the player itself. It implements the BMPPlayerAPI and BMPRemoteControlAPI which can be used to control the player. It also implements the BMPPlayerEventHandler interface which enables adding and removing of event listeners to this player instance. This player does not come with an UI, it represents only the player logic. If you wish to use the player along with an UI please use BMPBitmovinPlayerView.

    See more

    Declaration

    Objective-C

    
    @interface BMPBitmovinPlayer
        : NSObject <BMPPlayerAPI, BMPPlayerEventHandler, BMPRemoteControlAPI>

    Swift

    class Player : NSObject, PlayerAPI, PlayerEventHandler, BMPRemoteControlAPI
  • A view containing a BMPBitmovinPlayer which can be added to the view hierarchy of your view controller. This view needs a BMPBitmovinPlayer instance to work properly. This instance can be passed to the initializer, or using the according property if the view is created using the interface builder.

    See more

    Declaration

    Objective-C

    @interface BMPBitmovinPlayerView
        : BMPPlayerView <BMPUserInterfaceAPI, BMPUserInterfaceEventHandler>

    Swift

    class BMPBitmovinPlayerView : PlayerView, UserInterfaceAPI, UserInterfaceEventHandler
  • Undocumented

    See more

    Declaration

    Objective-C

    
    @interface BMPBitmovinUserInterfaceConfiguration : BMPUserInterfaceConfiguration

    Swift

    class BitmovinUserInterfaceConfiguration : UserInterfaceConfiguration
  • Player buffer configuration object to configure buffering behavior.

    See more

    Declaration

    Objective-C

    
    @interface BMPBufferConfiguration : BMPConfiguration

    Swift

    class BufferConfiguration : Configuration
  • Undocumented

    See more

    Declaration

    Objective-C

    
    @interface BMPBufferMediaTypeConfiguration : BMPConfiguration

    Swift

    class BufferMediaTypeConfiguration : Configuration
  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCastAvailableEvent : BMPPlayerEvent

    Swift

    class CastAvailableEvent : PlayerEvent
  • Deprecated

    Use BMPRemoteControlConfiguration instead.

    Contains configuration values which can be used to customize the cast receiver app. NOTE: This configuration class is deprecated and will be removed. Use BMPRemoteConfiguration instead.

    See more

    Declaration

    Objective-C

    
    @interface BMPCastConfiguration : BMPConfiguration

    Swift

    class CastConfiguration : Configuration
  • See BMPPlayerListener.h 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 BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCastPlaybackFinishedEvent : BMPPlayerEvent

    Swift

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

    Declaration

    Objective-C

    
    @interface BMPCastPlayingEvent : BMPPlayerEvent

    Swift

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

    Declaration

    Objective-C

    
    @interface BMPCastStartEvent : BMPPlayerEvent

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface BMPCastStartedEvent : BMPPlayerEvent

    Swift

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

    Declaration

    Objective-C

    
    @interface BMPCastStoppedEvent : BMPPlayerEvent

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface BMPCastTimeUpdatedEvent : BMPPlayerEvent

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface BMPCastWaitingForDeviceEvent : BMPPlayerEvent

    Swift

    class CastWaitingForDeviceEvent : PlayerEvent
  • Represents a ClearKey configuration.

    See more

    Declaration

    Objective-C

    
    @interface BMPClearKeyConfiguration : BMPDRMConfiguration

    Swift

    class ClearKeyConfiguration : DRMConfiguration
  • Base class for all configuration classes.

    See more

    Declaration

    Objective-C

    
    @interface BMPConfiguration : NSObject <BMPJsonable, NSCopying>

    Swift

    class Configuration : NSObject, BMPJsonable, NSCopying
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPConfigurationUpdatedEvent : BMPPlayerEvent

    Swift

    class ConfigurationUpdatedEvent : PlayerEvent
  • 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 BMPPlayerListener.h 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 BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPCueExitEvent : BMPCueEvent

    Swift

    class CueExitEvent : CueEvent
  • See BMPPlayerListener.h 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
  • Represents a DASH media source.

    See more

    Declaration

    Objective-C

    
    @interface BMPDASHSource : BMPAdaptiveSource

    Swift

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

    Note

    This class acts as an abstract class.
    See more

    Declaration

    Objective-C

    
    @interface BMPDRMConfiguration : BMPConfiguration

    Swift

    class DRMConfiguration : Configuration
  • 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 configuration options which can be used to alter the default behaviour of content downloads.

    See more

    Declaration

    Objective-C

    
    @interface BMPDownloadConfiguration : BMPConfiguration

    Swift

    class DownloadConfiguration : Configuration
  • 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.

    See more

    Declaration

    Objective-C

    
    @interface BMPDownloadTweaksConfiguration : BMPConfiguration

    Swift

    class DownloadTweaksConfiguration : Configuration
  • 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 BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPDvrWindowExceededEvent : BMPPlayerEvent

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface BMPFairplayConfiguration : BMPDRMConfiguration

    Swift

    class FairplayConfiguration : DRMConfiguration
  • See BMPUserInterfaceListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPFullscreenDisabledEvent : BMPPlayerEvent

    Swift

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

    Declaration

    Objective-C

    
    @interface BMPFullscreenEnabledEvent : BMPPlayerEvent

    Swift

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

    Declaration

    Objective-C

    
    @interface BMPFullscreenEnterEvent : BMPPlayerEvent

    Swift

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

    Declaration

    Objective-C

    
    @interface BMPFullscreenExitEvent : BMPPlayerEvent

    Swift

    class FullscreenExitEvent : PlayerEvent
  • Represents a HLS media source.

    See more

    Declaration

    Objective-C

    
    @interface BMPHLSSource : BMPAdaptiveSource

    Swift

    class HLSSource : AdaptiveSource
  • A configuration 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 BMPLabelingConfiguration : BMPConfiguration

    Swift

    class LabelingConfiguration : Configuration
  • 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
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPMetadataEvent : BMPPlayerEvent

    Swift

    class MetadataEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPMetadataParsedEvent : BMPMetadataEvent

    Swift

    class MetadataParsedEvent : MetadataEvent
  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPMutedEvent : BMPPlayerEvent

    Swift

    class MutedEvent : PlayerEvent
  • The network configuration gives the ability to influence network requests. It enables preprocessing requests, processing responses or influencing the retry behavior.

    See more

    Declaration

    Objective-C

    
    @interface BMPNetworkConfiguration : NSObject

    Swift

    class NetworkConfiguration : 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 SourceItem, which can be obtained by calling offlineStateForSourceItem:, 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 downloadSourceItem: - Downloading
    Downloading cancelDownloadForSourceItem: - Canceling
    Downloading suspendDownloadForSourceItem: offlineManagerDidSuspendDownload: Suspended
    Downloading - offlineManagerDidFinishDownload: Downloaded
    Downloading - offlineManager:didProgressTo: Downloading
    Downloaded deleteOfflineDataForSourceItem: - NotDownloaded
    Suspended resumeDownloadForSourceItem: offlineManager:didResumeDownloadWithProgress: Downloading
    Suspended cancelDownloadForSourceItem: - Canceling
    Canceling - offlineManagerDidCancelDownload: NotDownloaded
    Downloaded renewOfflineLicenseForSourceItem: offlineManagerDidRenewOfflineLicense: Downloaded
    See more

    Declaration

    Objective-C

    
    @interface BMPOfflineManager : NSObject

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface BMPOfflineSourceItem : BMPSourceItem

    Swift

    class OfflineSourceItem : SourceItem
  • 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
    @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
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPPausedEvent : BMPPlayerEvent

    Swift

    class PausedEvent : PlayerEvent
  • Represents a PlayReady DRM configuration.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayReadyConfiguration : BMPDRMConfiguration

    Swift

    class PlayReadyConfiguration : DRMConfiguration
  • Contains configuration values which can be used to alter the playback behaviour of the player.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlaybackConfiguration : BMPConfiguration

    Swift

    class PlaybackConfiguration : Configuration
  • Contains configuration values regarding the playback behaviour of the player.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayerConfiguration : BMPConfiguration

    Swift

    class PlayerConfiguration : Configuration
  • Base class for all event classes.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayerEvent : NSObject <BMPJsonable>

    Swift

    class PlayerEvent : NSObject, BMPJsonable
  • Factory to create a BMPBitmovinPlayer instance.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayerFactory : NSObject
  • Base class for player user interfaces which should work together with the BMPBitmovinPlayer. If you want to build your own UI on top of our player, extend this class.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayerView : UIView

    Swift

    class PlayerView : UIView
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPPlayingEvent : BMPPlayerEvent

    Swift

    class PlayingEvent : PlayerEvent
  • 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
  • Contains configuration values which can be used to alter the behaviour of the player when it comes to remote playback.

    See more

    Declaration

    Objective-C

    
    @interface BMPRemoteControlConfiguration : BMPConfiguration

    Swift

    class RemoteControlConfiguration : Configuration
  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPRenderFirstFrameEvent : BMPPlayerEvent

    Swift

    class RenderFirstFrameEvent : PlayerEvent
  • 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
  • Deprecated

    Use SourceItem instead.

    Contains configuration values regarding the media which should be played by the player.

    See more

    Declaration

    Objective-C

    
    @interface BMPSourceConfiguration : BMPConfiguration

    Swift

    class SourceConfiguration : Configuration
  • Represents a source item which can be played back in a player instance.

    See more

    Declaration

    Objective-C

    
    @interface BMPSourceItem : NSObject <BMPJsonable>

    Swift

    class SourceItem : NSObject, BMPJsonable
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPSourceMetadataChangedEvent : BMPPlayerEvent

    Swift

    class SourceMetadataChangedEvent : PlayerEvent
  • 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 BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPStallEndedEvent : BMPPlayerEvent

    Swift

    class StallEndedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPStallStartedEvent : BMPPlayerEvent

    Swift

    class StallStartedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPSubtitleAddedEvent : BMPPlayerEvent

    Swift

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

    See more

    Declaration

    Objective-C

    
    @interface BMPSubtitleChangedEvent : BMPPlayerEvent

    Swift

    class SubtitleChangedEvent : PlayerEvent
  • See BMPPlayerListener.h 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 BMPSubtitleUserInterfaceConfiguration : BMPUserInterfaceConfiguration

    Swift

    class SubtitleUserInterfaceConfiguration : UserInterfaceConfiguration
  • Undocumented

    See more

    Declaration

    Objective-C

    
    @interface BMPSystemUserInterfaceConfiguration : BMPUserInterfaceConfiguration

    Swift

    class SystemUserInterfaceConfiguration : UserInterfaceConfiguration
  • 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 BMPPlayerListener.h 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 BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
    @interface BMPUnmutedEvent : BMPPlayerEvent

    Swift

    class UnmutedEvent : PlayerEvent
  • Undocumented

    Declaration

    Objective-C

    
    @interface BMPUserInterfaceConfiguration : BMPConfiguration

    Swift

    class UserInterfaceConfiguration : Configuration
  • See BMPPlayerListener.h 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 BMPPlayerListener.h 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 BMPVttLine : 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 BMPVttPosition : 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
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
    @interface BMPWarningEvent : BMPPlayerEvent

    Swift

    class WarningEvent : PlayerEvent
  • Represents a Widevine DRM configuration.

    See more

    Declaration

    Objective-C

    
    @interface BMPWidevineConfiguration : BMPDRMConfiguration

    Swift

    class WidevineConfiguration : DRMConfiguration
  • Factory to create a Player instance.

    See more

    Declaration

    Swift

    public class PlayerFactory
  • Base class for ad break related event classes.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdBreakEvent)
    open class AdBreakEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdBreakFinishedEvent)
    open class AdBreakFinishedEvent : AdBreakEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdBreakStartedEvent)
    open class AdBreakStartedEvent : AdBreakEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdClickedEvent)
    open class AdClickedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdErrorEvent)
    open class AdErrorEvent : ErrorEvent
  • Base class for ad related event classes.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdEvent)
    open class AdEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdFinishedEvent)
    open class AdFinishedEvent : AdEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdManifestLoadEvent)
    open class AdManifestLoadEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdManifestLoadedEvent)
    open class AdManifestLoadedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdSkippedEvent)
    open class AdSkippedEvent : AdEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPAdStartedEvent)
    open class AdStartedEvent : AdEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    @objc(BMPDownloadFinishedEvent)
    @objcMembers
    public final class DownloadFinishedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPDrmDataParsedEvent)
    @objcMembers
    public final class DrmDataParsedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPDurationChangedEvent)
    @objcMembers
    public final class DurationChangedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPErrorEvent)
    open class ErrorEvent : 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 BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSeekEvent)
    public final class SeekEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceLoadedEvent)
    public final class SourceLoadedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceUnloadedEvent)
    public final class SourceUnloadedEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPSourceWillUnloadEvent)
    public final class SourceWillUnloadEvent : PlayerEvent
  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPTimeShiftedEvent)
    public final class TimeShiftedEvent : PlayerEvent
  • The options to be used for initializing BitmovinCastManager

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPLiveConfiguration)
    public final class LiveConfiguration : Configuration
  • Represents an HTTP request for DRM information.

    See more

    Declaration

    Swift

    @objc(BMPDrmRequest)
    @objcMembers
    public final class DrmRequest : HttpRequest
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPStyleConfiguration)
    public final class StyleConfiguration : Configuration
  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
    @objc(BMPTweaksConfiguration)
    public final class TweaksConfiguration : Configuration
  • 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(BMPOfflineConfiguration)
    @objcMembers
    public final class OfflineConfiguration : NSObject