Classes Reference


                    
                    
                    BMPAdItem

Represents an ad which can be scheduled in the play.

Declaration

Objective-C


@interface BMPAdItem : NSObject <_BMPJsonEncodable, NSCopying>

Swift

class AdItem : NSObject, _JsonEncodable, NSCopying


                    
                    
                    BMPAdPricing

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

Declaration

Objective-C


@interface BMPAdPricing : NSObject <_BMPJsonEncodable>

Swift

class AdPricing : NSObject, _JsonEncodable


                    
                    
                    BMPAdSource

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

Declaration

Objective-C


@interface BMPAdSource : NSObject <NSCopying>

Swift

class AdSource : NSObject, NSCopying


                    
                    
                    BMPAdSurvey

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

Declaration

Objective-C


@interface BMPAdSurvey : NSObject <_BMPJsonEncodable>

Swift

class AdSurvey : NSObject, _JsonEncodable


                    
                    
                    BMPAdSystem

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

Declaration

Objective-C


@interface BMPAdSystem : NSObject <_BMPJsonEncodable>

Swift

class AdSystem : NSObject, _JsonEncodable


                    
                    
                    BMPAdTag

Defines the url and type of an ad manifest.

Declaration

Objective-C


@interface BMPAdTag : NSObject <_BMPJsonEncodable>

Swift

class AdTag : NSObject, _JsonEncodable


                    
                    
                    BMPAdaptiveSource

Deprecated

Use SourceConfig(url:type:) instead.

Base class for all adaptive media sources.

Declaration

Objective-C


@interface BMPAdaptiveSource : BMPMediaSource

Swift

class AdaptiveSource : MediaSource


                    
                    
                    BMPAdvertiser

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

Declaration

Objective-C


@interface BMPAdvertiser : NSObject <_BMPJsonEncodable>

Swift

class Advertiser : NSObject, _JsonEncodable


                    
                    
                    BMPAdvertisingConfig

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

Declaration

Objective-C


@interface BMPAdvertisingConfig : BMPConfig

Swift

class AdvertisingConfig : Config


                    
                    
                    BMPConfig

Base class for all config classes.

Declaration

Objective-C


@interface BMPConfig : NSObject <NSCopying, _BMPJsonEncodable>

Swift

class Config : NSObject, NSCopying, _JsonEncodable


                    
                    
                    BMPCreative

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

Declaration

Objective-C


@interface BMPCreative : NSObject <_BMPJsonEncodable>

Swift

class Creative : NSObject, _JsonEncodable


                    
                    
                    BMPDASHSource

Deprecated

Use SourceConfig(url:type:) instead.

Represents a DASH media source.

Declaration

Objective-C


@interface BMPDASHSource : BMPAdaptiveSource

Swift

class DASHSource : AdaptiveSource


                    
                    
                    BMPDownloadConfig

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

Declaration

Objective-C


@interface BMPDownloadConfig : BMPConfig

Swift

class DownloadConfig : Config


                    
                    
                    BMPDownloadTweaksConfig

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

Declaration

Objective-C


@interface BMPDownloadTweaksConfig : BMPConfig

Swift

class DownloadTweaksConfig : Config


                    
                    
                    BMPHLSSource

Deprecated

Use SourceConfig(url:type:) instead.

Represents a HLS media source.

Declaration

Objective-C


@interface BMPHLSSource : BMPAdaptiveSource

Swift

class HLSSource : AdaptiveSource


                    
                    
                    BMPHttpRequest

A config object representing an HTTP request.

Declaration

Objective-C


@interface BMPHttpRequest : NSObject <NSCopying>

Swift

class HttpRequest : NSObject, NSCopying


                    
                    
                    BMPId3Metadata

Represents ID3 metadata found in the stream.

Declaration

Objective-C


@interface BMPId3Metadata : BMPMetadata

Swift

class Id3Metadata : Metadata


                    
                    
                    BMPMediaSource

Deprecated

Use SourceConfig(url:type:) instead.

Base class for all media sources.

Note

This class acts as an abstract class.

Declaration

Objective-C


@interface BMPMediaSource : NSObject <NSCopying>

Swift

class MediaSource : NSObject, NSCopying


                    
                    
                    BMPMetadata

Undocumented

Declaration

Objective-C

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

Swift

class Metadata : NSObject


                    
                    
                    BMPOfflineManager

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

Declaration

Objective-C


@interface BMPOfflineManager : NSObject

Swift

class OfflineManager : NSObject


                    
                    
                    BMPOfflineSourceConfig

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

Declaration

Objective-C


@interface BMPOfflineSourceConfig : BMPSourceConfig

Swift

class OfflineSourceConfig : SourceConfig


                    
                    
                    BMPPlayerConfig

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

Declaration

Objective-C


@interface BMPPlayerConfig : BMPConfig

Swift

class PlayerConfig : Config


                    
                    
                    BMPPlayerFactory

Factory to create a Player instance.

Declaration

Objective-C


@interface BMPPlayerFactory : NSObject


                    
                    
                    BMPProgressiveSource

Deprecated

Use SourceConfig(url:type:) instead.

Represents a progressive media source.

Declaration

Objective-C


@interface BMPProgressiveSource : BMPMediaSource

Swift

class ProgressiveSource : MediaSource


                    
                    
                    BMPScteMetadata

Represents the SCTE-35 metadata from the media playlist.

Declaration

Objective-C


@interface BMPScteMetadata : BMPMetadata

Swift

class ScteMetadata : Metadata


                    
                    
                    BMPSourceConfig

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

Declaration

Objective-C


@interface BMPSourceConfig : BMPConfig

Swift

class SourceConfig : Config


                    
                    
                    BMPSourceOptions

Undocumented

Declaration

Objective-C

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

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

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

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

Swift

class SourceOptions : NSObject, NSCopying, _JsonEncodable


                    
                    
                    BMPThumbnail

Represents a VTT thumbnail.

Declaration

Objective-C


@interface BMPThumbnail : NSObject <_BMPJsonEncodable>

Swift

class Thumbnail : NSObject, _JsonEncodable


                    
                    
                    BMPUniversalAdId

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

Declaration

Objective-C


@interface BMPUniversalAdId : NSObject <_BMPJsonEncodable>

Swift

class UniversalAdId : NSObject, _JsonEncodable


                    
                    
                    BMPBitmovinCastManager

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

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

Declaration

Objective-C


@interface BMPBitmovinCastManager : NSObject


                    
                    
                    PlayerFactory

Factory to create a Player instance.

Declaration

Swift

public class PlayerFactory


                    
                    
                    SourceFactory

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

Declaration

Swift

@objc(BMPSourceFactory)
public class SourceFactory : NSObject


                    
                    
                    AdBreakEvent

Base class for ad break related event classes.

Declaration

Swift

@objcMembers
@objc(BMPAdBreakEvent)
open class AdBreakEvent : PlayerEvent


                    
                    
                    AdBreakFinishedEvent

See BMPPlayerListener.h for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdBreakFinishedEvent)
open class AdBreakFinishedEvent : AdBreakEvent


                    
                    
                    AdBreakStartedEvent

See BMPPlayerListener.h for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdBreakStartedEvent)
open class AdBreakStartedEvent : AdBreakEvent


                    
                    
                    AdClickedEvent

See BMPPlayerListener.h for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdClickedEvent)
open class AdClickedEvent : PlayerEvent


                    
                    
                    AdErrorEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    AdEvent

Base class for ad related event classes.

Declaration

Swift

@objcMembers
@objc(BMPAdEvent)
open class AdEvent : PlayerEvent


                    
                    
                    AdFinishedEvent

See BMPPlayerListener.h for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdFinishedEvent)
open class AdFinishedEvent : AdEvent


                    
                    
                    AdManifestLoadEvent

See BMPPlayerListener.h for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdManifestLoadEvent)
open class AdManifestLoadEvent : PlayerEvent


                    
                    
                    AdManifestLoadedEvent

See BMPPlayerListener.h for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdManifestLoadedEvent)
open class AdManifestLoadedEvent : PlayerEvent


                    
                    
                    AdQuartileEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    AdScheduledEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPAdScheduledEvent)
@objcMembers
open class AdScheduledEvent : PlayerEvent


                    
                    
                    AdSkippedEvent

See BMPPlayerListener.h for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdSkippedEvent)
open class AdSkippedEvent : AdEvent


                    
                    
                    AdStartedEvent

See BMPPlayerListener.h for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPAdStartedEvent)
open class AdStartedEvent : AdEvent


                    
                    
                    AirPlayAvailableEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    AirPlayChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    AudioAddedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    AudioChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    AudioRemovedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastAvailableEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastPausedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastPlaybackFinishedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastPlayingEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastStartEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastStartedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastStoppedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastTimeUpdatedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CastWaitingForDeviceEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    ControlsHideEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

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


                    
                    
                    ControlsShowEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

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


                    
                    
                    CueEnterEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CueExitEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    CueParsedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    DeficiencyData

Provides additional data about a deficiency

Declaration

Swift

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


                    
                    
                    DestroyEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    DownloadFinishedEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    DrmDataParsedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    DurationChangedEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    DvrWindowExceededEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    FullscreenDisabledEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

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


                    
                    
                    FullscreenEnabledEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

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


                    
                    
                    FullscreenEnterEvent

Undocumented

Declaration

Swift

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


                    
                    
                    FullscreenExitEvent

Undocumented

Declaration

Swift

@objcMembers
@objc(BMPFullscreenExitEvent)
public class FullscreenExitEvent : PlayerEvent


                    
                    
                    MetadataEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPMetadataEvent)
public class MetadataEvent : PlayerEvent


                    
                    
                    MetadataParsedEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    MutedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPMutedEvent)
public class MutedEvent : PlayerEvent


                    
                    
                    PausedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PictureInPictureEnterEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

public class PictureInPictureEnterEvent : PlayerEvent


                    
                    
                    PictureInPictureEnteredEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

public class PictureInPictureEnteredEvent : PlayerEvent


                    
                    
                    PictureInPictureExitEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

public class PictureInPictureExitEvent : PlayerEvent


                    
                    
                    PictureInPictureExitedEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

public class PictureInPictureExitedEvent : PlayerEvent


                    
                    
                    PlayEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlaybackFinishedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlaybackSpeedChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlayerActiveEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlayerErrorEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlayerEvent

Base class for all PlayerEvent classes.

Declaration

Swift

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


                    
                    
                    PlayerInactiveEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlayerWarningEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlayingEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlaylistTransitionEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    ReadyEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPReadyEvent)
public class ReadyEvent : PlayerEvent


                    
                    
                    RenderFirstFrameEvent

See PlayerListener for more information on this event.

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


                    
                    
                    ScalingModeChangedEvent

See BMPUserInterfaceListener.h for more information on this event.

Declaration

Swift

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


                    
                    
                    SeekEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSeekEvent)
public class SeekEvent : PlayerEvent


                    
                    
                    SeekPosition

Class represent seeking position

Declaration

Swift

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


                    
                    
                    SeekedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objcMembers
@objc(BMPSeekedEvent)
public class SeekedEvent : PlayerEvent


                    
                    
                    SourceAddedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPSourceAddedEvent)
@objcMembers
public class SourceAddedEvent : PlayerEvent


                    
                    
                    SourceErrorEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    SourceLoadedEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    SourceRemovedEvent

See PlayerListener for more information on this event.

Declaration

Swift

@objc(BMPSourceRemovedEvent)
@objcMembers
public class SourceRemovedEvent : PlayerEvent


                    
                    
                    SourceUnloadEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    SourceUnloadedEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    SourceWarningEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    StallEndedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    StallStartedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    SubtitleAddedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    SubtitleChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    SubtitleRemovedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    TimeChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    TimeShiftEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    TimeShiftedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    UnmutedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    VideoDownloadQualityChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    VideoSizeChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    SourceLoadEvent

See SourceListener for more information on this event.

Declaration

Swift

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


                    
                    
                    BitmovinCastManagerOptions

The options to be used for initializing BitmovinCastManager

Declaration

Swift

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


                    
                    
                    CastPayload

A class holding information for the CastWaitingForDeviceEvent.

Declaration

Swift

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


                    
                    
                    AdaptationConfig

Contains config values regarding the behaviour of the bitrate adaptation.

Declaration

Swift

@objcMembers
@objc(BMPAdaptationConfig)
public class AdaptationConfig : Config


                    
                    
                    ImaAdAttributionUiMode

Defines the IMA Ad attribution UI mode

Declaration

Swift

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


                    
                    
                    ImaAdvertisingConfig

Contains configuration options to customize behavior for Google IMA SDK.

Declaration

Swift

@objcMembers
@objc(BMPImaAdvertisingConfig)
public class ImaAdvertisingConfig : NSObject


                    
                    
                    BufferConfig

Player buffer config object to configure buffering behavior.

Declaration

Swift

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


                    
                    
                    BufferMediaTypeConfig

Undocumented

Declaration

Swift

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


                    
                    
                    ClearKeyConfig

Represents a ClearKey config.

Declaration

Swift

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


                    
                    
                    DecryptionKey

Represents a decryption key for a ClearKey DRM config

Declaration

Swift

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


                    
                    
                    DrmConfig

Base class for all DRM configs.

Note

This class acts as an abstract class.

Declaration

Swift

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


                    
                    
                    DrmSystems

Provides access to DRM scheme UUIDs.

Declaration

Swift

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


                    
                    
                    FairplayConfig

Represents a FairPlay Streaming DRM config.

Declaration

Swift

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


                    
                    
                    PlayReadyConfig

Represents a PlayReady DRM config.

Declaration

Swift

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


                    
                    
                    WidevineConfig

Represents a Widevine DRM config.

Declaration

Swift

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


                    
                    
                    LiveConfig

Contains config values regarding the behaviour when playing live streams.

Declaration

Swift

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


                    
                    
                    LabelingConfig

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

Declaration

Swift

@objcMembers
@objc(BMPLabelingConfig)
public class LabelingConfig : Config


                    
                    
                    DrmRequest

Represents an HTTP request for DRM information.

Declaration

Swift

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


                    
                    
                    NetworkConfig

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.

Declaration

Swift

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


                    
                    
                    PlaybackConfig

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

Declaration

Swift

@objcMembers
@objc(BMPPlaybackConfig)
public class PlaybackConfig : Config


                    
                    
                    PlaylistConfig

Configures a playlist that can be loaded into a Player.

Declaration

Swift

@objcMembers
@objc(BMPPlaylistConfig)
public final class PlaylistConfig : Config


                    
                    
                    PlaylistOptions

Contains additional configuration options for setting up a playlist.

Declaration

Swift

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


                    
                    
                    Quality

Quality definition of a media representation.

Note: This class acts as an abstract class.

Declaration

Swift

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


                    
                    
                    VideoQuality

Quality definition of a video representation.

Declaration

Swift

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


                    
                    
                    RemoteControlConfig

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

Declaration

Swift

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


                    
                    
                    BitmovinUserInterfaceConfig

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

Declaration

Swift

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


                    
                    
                    StyleConfig

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

Declaration

Swift

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


                    
                    
                    SubtitleUserInterfaceConfig

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

Declaration

Swift

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


                    
                    
                    SystemUserInterfaceConfig

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

Declaration

Swift

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


                    
                    
                    UserInterfaceConfig

Undocumented

Declaration

Swift

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


                    
                    
                    AudioTrack

Describes an audio track.

Declaration

Swift

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

Cue

Describes a subtitle cue.

Declaration

Swift

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


                    
                    
                    CuePosition

Positioning information for CEA captions

Declaration

Swift

@objcMembers
@objc(BMPCuePosition)
public class CuePosition : NSObject


                    
                    
                    SubtitleTrack

Describes a subtitle track.

Declaration

Swift

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


                    
                    
                    ThumbnailTrack

Describes a thumbnail track.

Declaration

Swift

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


                    
                    
                    Track

Base class for all available tracks.

Note

This class acts as an abstract class.

Declaration

Swift

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


                    
                    
                    TweaksConfig

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

Declaration

Swift

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


                    
                    
                    DaterangeMetadata

Represents in-playlist timed metadata.

Declaration

Swift

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


                    
                    
                    DrmData

Undocumented

Declaration

Swift

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


                    
                    
                    ScteMetadataEntry

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

Declaration

Swift

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


                    
                    
                    BufferLevel

Holds different information about the buffer levels.

Declaration

Swift

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


                    
                    
                    VttLine

Undocumented

Declaration

Swift

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


                    
                    
                    VttPosition

Undocumented

Declaration

Swift

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


                    
                    
                    VttProperties

Undocumented

Declaration

Swift

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


                    
                    
                    DrmLicenseInformation

Holds DRM licence information

Declaration

Swift

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


                    
                    
                    OfflineConfig

Configures the offline functionality

Declaration

Swift

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


                    
                    
                    OfflineAudioTrack

Undocumented

Declaration

Swift

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


                    
                    
                    OfflineTextTrack

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

Declaration

Swift

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


                    
                    
                    OfflineTrack

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

Declaration

Swift

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


                    
                    
                    OfflineTrackSelection

Represents the information which tracks to download for offline playback

Declaration

Swift

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


                    
                    
                    SourceMetadataChangedEvent

See PlayerListener for more information on this event.

Declaration

Swift

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


                    
                    
                    PlayerView

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

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

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

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

    var playerLayer: AVPlayerLayer {
        layer as! AVPlayerLayer
    }

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

Declaration

Swift

@objcMembers
@objc(BMPPlayerView)
open class PlayerView : UIView

extension PlayerView: UIScrollViewDelegate

extension PlayerView: UserInterfaceApi

extension PlayerView: UserInterfaceEventHandler

extension PlayerView: _PlayerListenerInternal


                    
                    
                    CustomMessageHandler

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

Declaration

Swift

@objcMembers
@objc(BMPCustomMessageHandler)
public class CustomMessageHandler : NSObject