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 <_BMPJsonEncodable, NSCopying>

    Swift

    class AdItem : NSObject, _JsonEncodable, 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 <_BMPJsonEncodable>

    Swift

    class AdPricing : NSObject, _JsonEncodable

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

    Swift

    class AdSurvey : NSObject, _JsonEncodable

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

    See more

    Declaration

    Objective-C

    
@interface BMPAdSystem : NSObject <_BMPJsonEncodable>

    Swift

    class AdSystem : NSObject, _JsonEncodable

  • Defines the url and type of an ad manifest.

    See more

    Declaration

    Objective-C

    
@interface BMPAdTag : NSObject <_BMPJsonEncodable>

    Swift

    class AdTag : NSObject, _JsonEncodable

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

    Swift

    class Advertiser : NSObject, _JsonEncodable

  • 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

  • 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

  • Base class for all config classes.

    Declaration

    Objective-C

    
@interface BMPConfig : NSObject <NSCopying, _BMPJsonEncodable>

    Swift

    class Config : NSObject, NSCopying, _JsonEncodable

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

    Swift

    class Creative : NSObject, _JsonEncodable

  • 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

  • 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

  • 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

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

  • 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

  • Factory to create a Player instance.

    See more

    Declaration

    Objective-C

    
@interface BMPPlayerFactory : 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 <_BMPJsonEncodable>

    Swift

    class Quality : NSObject, _JsonEncodable

  • 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, _BMPJsonEncodable>
/**
 The position where the stream should be started. Number can be positive or negative depending on the used TimelineReferencePoint.
 Invalid numbers will be corrected according to the stream boundaries.
 For VOD this is applied at the time the stream is loaded, for LIVE when the playback starts.

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

 Default for live: BMPTimelineReferencePointEnd
 Default for VOD: BMPTimelineReferencePointStart
 */
@property (nonatomic) BMPTimelineReferencePoint startOffsetTimelineReference;

- (instancetype)initWithStartOffset:(NSTimeInterval)startOffset
  startOffsetTimelineReferencePoint:(BMPTimelineReferencePoint)startOffsetTimelineReference NS_DESIGNATED_INITIALIZER;
@end

    Swift

    class SourceOptions : NSObject, NSCopying, _JsonEncodable

  • Represents a VTT thumbnail.

    See more

    Declaration

    Objective-C

    
@interface BMPThumbnail : NSObject <_BMPJsonEncodable>

    Swift

    class Thumbnail : NSObject, _JsonEncodable

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

    Swift

    class UniversalAdId : NSObject, _JsonEncodable

  • Undocumented

    See more

    Declaration

    Objective-C

    
@interface BMPVideoQuality : BMPQuality

    Swift

    class VideoQuality : Quality

  • Factory to create a Player instance.

    See more

    Declaration

    Swift

    public class PlayerFactory

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

    See more

    Declaration

    Swift

    @objc(BMPSourceFactory)
public class SourceFactory : NSObject

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

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPAdErrorEvent)
open class AdErrorEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    @objc(BMPAdQuartileEvent)
@objcMembers
open class AdQuartileEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPAdScheduledEvent)
@objcMembers
open class AdScheduledEvent : 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 PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPAirPlayAvailableEvent)
public class AirPlayAvailableEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPAirPlayChangedEvent)
public class AirPlayChangedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPCastAvailableEvent)
@objcMembers
open class CastAvailableEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPCastPausedEvent)
@objcMembers
open class CastPausedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPCastPlaybackFinishedEvent)
@objcMembers
open class CastPlaybackFinishedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPCastPlayingEvent)
@objcMembers
open class CastPlayingEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPCastStartEvent)
@objcMembers
open class CastStartEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPCastStartedEvent)
@objcMembers
open class CastStartedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPCastStoppedEvent)
@objcMembers
open class CastStoppedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPCastTimeUpdatedEvent)
@objcMembers
open class CastTimeUpdatedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

    @objc(BMPControlsHideEvent)
@objcMembers
open class ControlsHideEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    @objc(BMPControlsShowEvent)
@objcMembers
open class ControlsShowEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • Provides additional data about a deficiency

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPDestroyEvent)
public class DestroyEvent : PlayerEvent

  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPDvrWindowExceededEvent)
@objcMembers
open class DvrWindowExceededEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPFullscreenDisabledEvent)
public class FullscreenDisabledEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPFullscreenEnabledEvent)
public class FullscreenEnabledEvent : PlayerEvent

  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPFullscreenEnterEvent)
public class FullscreenEnterEvent : PlayerEvent

  • Undocumented

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPFullscreenExitEvent)
public 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 class MutedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPPausedEvent)
public class PausedEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    public class PictureInPictureEnterEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    public class PictureInPictureEnteredEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    public class PictureInPictureExitEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    public class PictureInPictureExitedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPPlayEvent)
@objcMembers
public class PlayEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPPlaybackFinishedEvent)
@objcMembers
public class PlaybackFinishedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPPlaybackSpeedChangedEvent)
public class PlaybackSpeedChangedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPPlayerActiveEvent)
public class PlayerActiveEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPPlayerErrorEvent)
public class PlayerErrorEvent : PlayerEvent

  • Base class for all PlayerEvent classes.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPPlayerInactiveEvent)
public class PlayerInactiveEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPPlayerWarningEvent)
public class PlayerWarningEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPPlayingEvent)
public class PlayingEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPPlaylistTransitionEvent)
public class PlaylistTransitionEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPReadyEvent)
public 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 class RenderFirstFrameEvent : PlayerEvent

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

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPScalingModeChangedEvent)
public class ScalingModeChangedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPSeekEvent)
public 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 class SeekedEvent : PlayerEvent

  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPSourceWarningEvent)
public class SourceWarningEvent : NSObject, SourceEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPStallEndedEvent)
public class StallEndedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPStallStartedEvent)
public class StallStartedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPTimeChangedEvent)
open class TimeChangedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPTimeShiftEvent)
public class TimeShiftEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPTimeShiftedEvent)
public class TimeShiftedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objc(BMPUnmutedEvent)
@objcMembers
open class UnmutedEvent : PlayerEvent

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPVideoSizeChangedEvent)
open class VideoSizeChangedEvent : PlayerEvent

  • See SourceListener for more information on this event.

    See more

    Declaration

    Swift

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

  • The options to be used for initializing BitmovinCastManager

    See more

    Declaration

    Swift

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

  • A class holding information for the CastWaitingForDeviceEvent.

    See more

    Declaration

    Swift

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

  • 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

  • Represents a ClearKey config.

    See more

    Declaration

    Swift

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

  • Represents a decryption key for a ClearKey DRM config

    See more

    Declaration

    Swift

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

  • Base class for all DRM configs.

    Note

    This class acts as an abstract class.
    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPDrmConfig)
public class DrmConfig : Config

  • Provides access to DRM scheme UUIDs.

    See more

    Declaration

    Swift

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

  • Represents a FairPlay Streaming DRM config.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPFairplayConfig)
public class FairplayConfig : DrmConfig

  • Represents a PlayReady DRM config.

    See more

    Declaration

    Swift

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

  • Represents a Widevine DRM config.

    See more

    Declaration

    Swift

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

  • Contains config values regarding the behaviour when playing live streams.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPLiveConfig)
public final class LiveConfig : Config

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

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPLabelingConfig)
public class LabelingConfig : 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

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

    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

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

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPBitmovinUserInterfaceConfig)
public class BitmovinUserInterfaceConfig : UserInterfaceConfig

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

    See more

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPSubtitleUserInterfaceConfig)
public class SubtitleUserInterfaceConfig : UserInterfaceConfig

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

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPSystemUserInterfaceConfig)
public class SystemUserInterfaceConfig : UserInterfaceConfig

  • Undocumented

    Declaration

    Swift

    @objcMembers
@objc(BMPUserInterfaceConfig)
public class UserInterfaceConfig : Config

  • Describes an audio track.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPAudioTrack)
public class AudioTrack : Track
  • Cue

    Describes a subtitle cue.

    See more

    Declaration

    Swift

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

  • Describes a subtitle track.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPSubtitleTrack)
public class SubtitleTrack : Track

  • Describes a thumbnail track.

    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPThumbnailTrack)
public class ThumbnailTrack : Track

  • Base class for all available tracks.

    Note

    This class acts as an abstract class.
    See more

    Declaration

    Swift

    @objcMembers
@objc(BMPTrack)
public class Track : NSObject

  • 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

    Swift

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

  • Represents in-playlist timed metadata.

    See more

    Declaration

    Swift

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

  • 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(BMPVttLine)
@objcMembers
public final class VttLine : NSObject

  • Undocumented

    See more

    Declaration

    Swift

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

  • Undocumented

    See more

    Declaration

    Swift

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

  • Holds DRM licence information

    See more

    Declaration

    Swift

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

  • Configures the offline functionality

    See more

    Declaration

    Swift

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

  • Undocumented

    See more

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

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

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

    See more

    Declaration

    Swift

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

  • Represents the information which tracks to download for offline playback

    See more

    Declaration

    Swift

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

  • See PlayerListener for more information on this event.

    See more

    Declaration

    Swift

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