Classes

The following classes are available globally.

  • 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.

    Declaration

    Objective-C

    
@interface BMPAdBreakFinishedEvent : BMPPlayerEvent

    Swift

    class AdBreakFinishedEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPAdBreakStartedEvent : BMPPlayerEvent

    Swift

    class AdBreakStartedEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPAdClickedEvent : BMPPlayerEvent

    Swift

    class AdClickedEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPAdErrorEvent : BMPErrorEvent

    Swift

    class AdErrorEvent : ErrorEvent

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPAdFinishedEvent : BMPPlayerEvent

    Swift

    class AdFinishedEvent : PlayerEvent

  • Represents an ad which can be scheduled in the play.

    See more

    Declaration

    Objective-C

    
@interface BMPAdItem : NSObject <BMPJsonable>

    Swift

    class AdItem : NSObject, Jsonable

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPAdScheduledEvent : BMPPlayerEvent

    Swift

    class AdScheduledEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPAdSkippedEvent : BMPPlayerEvent

    Swift

    class AdSkippedEvent : 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

    Swift

    class AdSource : NSObject

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPAdStartedEvent : BMPPlayerEvent

    Swift

    class AdStartedEvent : PlayerEvent

  • Contains configuration values regarding the behaviour of the bitrate adaptation.

    See more

    Declaration

    Objective-C

    
@interface BMPAdaptationConfiguration : NSObject <BMPJsonable>

    Swift

    class AdaptationConfiguration : NSObject, Jsonable

  • Base class for all adaptive media sources.

    Declaration

    Objective-C

    
@interface BMPAdaptiveSource : BMPMediaSource

    Swift

    class AdaptiveSource : MediaSource

  • 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.

    See more

    Declaration

    Objective-C

    
@interface BMPAudioAddedEvent : BMPPlayerEvent

    Swift

    class AudioAddedEvent : PlayerEvent

  • 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 BitmovinPlayer : 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

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPCastAvailableEvent : BMPPlayerEvent

    Swift

    class CastAvailableEvent : PlayerEvent

  • 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

  • Base class for all configuration classes.

    Declaration

    Objective-C

    
@interface BMPConfiguration : NSObject <BMPJsonable, NSCopying>

    Swift

    class Configuration : NSObject, Jsonable, NSCopying

  • 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

  • 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

  • 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

  • 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, Jsonable

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPDestroyEvent : BMPPlayerEvent

    Swift

    class DestroyEvent : PlayerEvent

  • 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

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPErrorEvent : BMPPlayerEvent

    Swift

    class ErrorEvent : PlayerEvent

  • 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

  • A configuration object representing an HTTP request.

    See more

    Declaration

    Objective-C

    
@interface BMPHttpRequest : NSObject <NSCopying>

    Swift

    class HttpRequest : NSObject, NSCopying

  • 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

  • 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

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPPausedEvent : BMPPlayerEvent

    Swift

    class PausedEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPPlayEvent : BMPPlayerEvent

    Swift

    class PlayEvent : PlayerEvent

  • 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

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPPlaybackFinishedEvent : BMPPlayerEvent

    Swift

    class PlaybackFinishedEvent : PlayerEvent

  • 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

    Swift

    class PlayerEvent : NSObject

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

    See more

    Declaration

    Objective-C

    
@interface BMPPlayerView

    Swift

    class PlayerView

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPPlayingEvent : BMPPlayerEvent

    Swift

    class PlayingEvent : PlayerEvent

  • 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, Jsonable

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPReadyEvent : BMPPlayerEvent

    Swift

    class ReadyEvent : PlayerEvent

  • 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

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPSeekEvent : BMPPlayerEvent

    Swift

    class SeekEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPSeekedEvent : BMPPlayerEvent

    Swift

    class SeekedEvent : PlayerEvent

  • 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, Jsonable

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPSourceUnloadedEvent : BMPPlayerEvent

    Swift

    class SourceUnloadedEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPSourceWillUnloadEvent : BMPPlayerEvent

    Swift

    class SourceWillUnloadEvent : PlayerEvent

  • 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

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

    See more

    Declaration

    Objective-C

    
@interface BMPStyleConfiguration : BMPConfiguration

    Swift

    class StyleConfiguration : Configuration

  • Represents a VTT thumbnail.

    See more

    Declaration

    Objective-C

    
@interface BMPThumbnail : NSObject <BMPJsonable>

    Swift

    class Thumbnail : NSObject, Jsonable

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPTimeChangedEvent : BMPPlayerEvent

    Swift

    class TimeChangedEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPTimeShiftEvent : BMPPlayerEvent

    Swift

    class TimeShiftEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPTimeShiftedEvent : BMPPlayerEvent

    Swift

    class TimeShiftedEvent : 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, Jsonable

  • This class is used to turn on/off special features of the player that are implemented for specific customers which might not be suitable for all use-cases.

    See more

    Declaration

    Objective-C

    
@interface BMPTweaksConfiguration : BMPConfiguration

    Swift

    class TweaksConfiguration : Configuration

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPUnmutedEvent : BMPPlayerEvent

    Swift

    class UnmutedEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    Declaration

    Objective-C

    
@interface BMPVideoSizeChangedEvent : BMPPlayerEvent

    Swift

    class VideoSizeChangedEvent : PlayerEvent

  • See BMPPlayerListener.h for more information on this event.

    See more

    Declaration

    Objective-C

    
@interface BMPWarningEvent : BMPPlayerEvent

    Swift

    class WarningEvent : PlayerEvent