BMPPlayerConfiguration

Objective-C


@interface BMPPlayerConfiguration : BMPConfiguration

Swift

class PlayerConfiguration : Configuration

Contains configuration values regarding the playback behaviour of the player.

  • key

    A personal key can be found in the bitmovin portal and can be specified here (in addition to the one in the Info.plist) Do not forget to enter all your domains (subdomains are included) in your account.

    If a license key is set here, it will be used instead of the license key found in Info.plist.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *key;

    Swift

    var key: String? { get set }

  • Deprecated

    Use PlayerConfiguration.sourceItem instead.

    The BMPSourceConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPSourceConfiguration *sourceConfiguration;

    Swift

    var sourceConfiguration: SourceConfiguration { get set }

  • The BMPStyleConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPStyleConfiguration *styleConfiguration;

    Swift

    var styleConfiguration: BMPStyleConfiguration { get set }

  • The BMPPlaybackConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPPlaybackConfiguration *playbackConfiguration;

    Swift

    var playbackConfiguration: PlaybackConfiguration { get set }

  • The BMPAdvertisingConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPAdvertisingConfiguration *advertisingConfiguration;

    Swift

    var advertisingConfiguration: AdvertisingConfiguration { get set }

  • The BMPCastConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPCastConfiguration *castConfiguration;

    Swift

    var castConfiguration: CastConfiguration { get set }

  • The BMPRemoteControlConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPRemoteControlConfiguration *remoteControlConfiguration;

    Swift

    var remoteControlConfiguration: RemoteControlConfiguration { get set }

  • The BMPAdaptationConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPAdaptationConfiguration *adaptationConfiguration;

    Swift

    var adaptationConfiguration: AdaptationConfiguration { get set }

  • The BMPNetworkConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPNetworkConfiguration *networkConfiguration;

    Swift

    var networkConfiguration: NetworkConfiguration { get set }

  • The BMPTweaksConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPTweaksConfiguration *tweaksConfiguration;

    Swift

    var tweaksConfiguration: BMPTweaksConfiguration { get set }

  • The BMPBufferConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPBufferConfiguration *bufferConfiguration;

    Swift

    var bufferConfiguration: BufferConfiguration { get set }

  • The BMPLiveConfiguration of this BMPPlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) BMPLiveConfiguration *liveConfiguration;

    Swift

    var liveConfiguration: BMPLiveConfiguration { get set }

  • Get/Set a source item for this PlayerConfiguration. When a source item is set, also a new new SourceConfiguration containing this single source item is created for this PlayerConfiguration.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) BMPSourceItem *sourceItem;

    Swift

    var sourceItem: SourceItem? { get set }

  • Creates and returns a BMPPlayerConfiguration based on the given JSON String.

    Declaration

    Objective-C

    + (nullable instancetype)fromJsonString:(nonnull NSString *)jsonString
                                  error:(NSError *_Nullable *_Nullable)error;

    Swift

    class func fromJsonString(_ jsonString: String) throws -> Self

    Parameters

    jsonString

    The JSON string representing the BMPPlayerConfiguration.

  • Sets a new source item based on the provided url for this PlayerConfiguration.

    Declaration

    Objective-C

    - (BOOL)setSourceItemWithString:(nonnull NSString *)urlString
                          error:(NSError *_Nullable *_Nullable)error;

    Swift

    func setSourceItem(urlString: String) throws

    Parameters

    urlString

    The url to a DASH, HLS or Progressive MP4 source which is used to create a new SourceConfiguration and SourceItem for this PlayerConfiguration.

  • Sets a new source item based on the provided url for this PlayerConfiguration.

    Declaration

    Objective-C

    - (BOOL)setSourceItemWithUrl:(nonnull NSURL *)url
                       error:(NSError *_Nullable *_Nullable)error;

    Swift

    func setSourceItem(url: URL) throws

    Parameters

    url

    The url to a DASH, HLS or Progressive MP4 source which is used to create a new SourceConfiguration and SourceItem for this PlayerConfiguration.