BBNativePlayerView

The BBNativePlayerViewDelegate

public weak var delegate: BBNativePlayerViewDelegate?

Undocumented

public var player: BBNativePlayerAPI

Call a method in the Blue Billywig player API

Methods:*

Use the ApiMethod enumeration to choose the method to call on the API

ApiMethod.load_

Use this method to load content into the player.

• arguments:
  • clipId: String
  • cliplistId: String
  • projectId: String
  • initiator: String
  • autoPlay: Bool
  • seekTo: NSNumber
  • clipData: MediaClip
  • clipListData: MediaClipList
  • clipDataJsonString: String
  • projectDataJsonString: String
  • clipListDataJsonString: String

example:

callApiMethod(method: .load_, args: ["clipId": "1084217", "autoPlay": true])

ApiMethod.play

Starts playback

example:

callApiMethod(method: .play, args: nil)

ApiMethod.pause

Pauses playback

example:

callApiMethod(method: .pause, args: nil)

ApiMethod.autoplaynextcancel

Stops the autoplaynext timer

example:

callApiMethod(method: .autoplaynextcancel, args: nil)

ApiMethod.seek

Seek the content to the fiven time in seconds

• arguments:
  • offsetInSeconds: NSNumber

example:

callApiMethod(method: .seek, args: ["offsetInSeconds": 10])

public func callApiMethod(method: ApiMethod, args: [String : Any?]?)

Sets a property through the Blue Billywig player API

Properties:*

Use the ApiProperty enumeration to choose the property to set

ApiProperty.inview

Sets the inview state (visible on screen) of the player

• value: Bool

example:

setApiProperty(property: .inview, value: true)

ApiProperty.muted

Mutes or unmutes the player

• value: Bool

example:

setApiProperty(property: .muted, value: true)

ApiProperty.volume

Sets the player volume

• value: Float

example:

setApiProperty(property: .volume, value: Float(0.73))

public func setApiProperty(property: ApiProperty, value: Any?)

Gets a property through the Blue Billywig player API

Properties:*

Use the ApiProperty enumeration to choose the property to get

ApiProperty.clipdata

Gets the Clip data of the current MediaClip

• return value: MediaClip

example:

if let mediaClip: MediaClip = bbPlayerView?.getApiProperty(property: .clipdata) as? MediaClip {
    .....
}

ApiProperty.projectdata

Gets the Project data of the current Project

• return value: Project

example:

if let project: Project = bbPlayerView?.getApiProperty(property: .projectdata) as? Project {
    .....
}

ApiProperty.playoutdata

Gets the Playout data of the player

• return value: Playout

example:

if let playout: Playout = bbPlayerView?.getApiProperty(property: .playoutdata) as? Playout {
    .....
}

ApiProperty.duration

Gets the duration of the current content

• return value: Double

example:

if ( bbPlayerView?.getApiProperty(property: .duration) != nil ) {
    .....
}

ApiProperty.inview

Gets the inview state (visible on screen) of the player

• return value: Bool

example:

bbPlayerView?.getApiProperty(property: .inview)

ApiProperty.mode

Gets the current Mode of the player

• return value: String

example:

if let mode: String = bbPlayerView?.getApiProperty(property: .mode) as? String {
    .....
}

ApiProperty.muted

Gets the current mute state of the player

• return value: Bool

example:

if let muted: Bool = bbPlayerView?.getApiProperty(property: .muted) as? Bool {
    .....
}

ApiProperty.phase

Gets the current Phase of the player

• return value: Phase enum

example:

if let phase: Phase = bbPlayerView?.getApiProperty(property: .phase) as? Phase {
    .....
}

ApiProperty.state

Gets the current State of the player

• return value: State enum

example:

if let state: State = bbPlayerView?.getApiProperty(property: .state) as? State {
    .....
}

ApiProperty.volume

Gets the current volume of the player

• return value: Float

example:

if let volume: Float = bbPlayerView?.getApiProperty(property: .volume) as? Float {
    .....
}

public func getApiProperty(property: ApiProperty) -> Any?

Destroys the player and handles memory cleanup. Call this method when you’re done with the BBNativePlayerView instance

public func destroy()