BBNativePlayerAPI Class Reference


                    
                    
                    closeModalPlayer()

Closes an existing modal player

Declaration

Swift

public func closeModalPlayer()


                    
                    
                    getModalPlayerView()

Return the UIView used by the ModalPlayer, you can use this to add your own UI elements on top

Declaration

Swift

public func getModalPlayerView() -> UIView?


                    
                    
                    loadWithClipId(clipId:initiator:autoPlay:seekTo:)

Load With Clip Id

Declaration

Swift

public func loadWithClipId(clipId: String, initiator: String? = "external", autoPlay: Bool? = true, seekTo: NSNumber? = nil)


                    
                    
                    loadWithClipListId(clipListId:initiator:autoPlay:seekTo:)

Load With Clip List Id

Declaration

Swift

public func loadWithClipListId(clipListId: String, initiator: String? = "external", autoPlay: Bool? = true, seekTo: NSNumber? = nil)


                    
                    
                    loadWithProjectId(projectId:initiator:autoPlay:seekTo:)

Load With Project Id

Declaration

Swift

public func loadWithProjectId(projectId: String, initiator: String? = "external", autoPlay: Bool? = true, seekTo: NSNumber? = nil)


                    
                    
                    loadWithClipJson(clipJson:initiator:autoPlay:seekTo:)

Load With Clip JSON

Declaration

Swift

public func loadWithClipJson(clipJson: String, initiator: String? = "external", autoPlay: Bool? = true, seekTo: NSNumber? = nil)


                    
                    
                    loadWithClipListJson(clipListJson:initiator:autoPlay:seekTo:)

Load With Clip List JSON

Declaration

Swift

public func loadWithClipListJson(clipListJson: String, initiator: String? = "external", autoPlay: Bool? = true, seekTo: NSNumber? = nil)


                    
                    
                    loadWithProjectJson(projectJson:initiator:autoPlay:seekTo:)

Load With Project JSON

Declaration

Swift

public func loadWithProjectJson(projectJson: String, initiator: String? = "external", autoPlay: Bool? = true, seekTo: NSNumber? = nil)


                    
                    
                    play()

Start / Resume playback

Declaration

Swift

public func play()


                    
                    
                    pause()

Pause playback

Declaration

Swift

public func pause()


                    
                    
                    seek(offsetInSeconds:)

Seek to time offset

Declaration

Swift

public func seek(offsetInSeconds: NSNumber)


                    
                    
                    autoPlayNextCancel()

Cancel AutoPlayNext countdown

Declaration

Swift

public func autoPlayNextCancel()


                    
                    
                    collapse()

Collapse

Declaration

Swift

public func collapse()


                    
                    
                    expand()

Expand

Declaration

Swift

public func expand()


                    
                    
                    phase

Phase (read-only) @see https://support.bluebillywig.com/player-api/events-modes-and-phases/#3-0-phases

Declaration

Swift

public var phase: Phase? { get }


                    
                    
                    state

State (read-only) @see https://support.bluebillywig.com/player-api/events-modes-and-phases/#4-0-states

Declaration

Swift

public var state: State? { get }


                    
                    
                    mode

Mode (read-only) @see https://support.bluebillywig.com/player-api/events-modes-and-phases/#2-0-modes

Declaration

Swift

public var mode: String? { get }


                    
                    
                    playoutData

Playout data (read-only)

Declaration

Swift

public var playoutData: Playout? { get }


                    
                    
                    projectData

Project data (read-only)

Declaration

Swift

public var projectData: Project? { get }


                    
                    
                    clipData

Clip data (read-only)

Declaration

Swift

public var clipData: MediaClip? { get }


                    
                    
                    volume

Volume [0.0 - 1.0]

Declaration

Swift

public var volume: Float? { get set }


                    
                    
                    muted

Muted state

Declaration

Swift

public var muted: Bool? { get set }


                    
                    
                    inView

InView override

Declaration

Swift

public var inView: Bool? { get set }


                    
                    
                    duration

Media duration in seconds (read-only)

Declaration

Swift

public var duration: Double? { get }


                    
                    
                    createChromeCastButton

Create Cast button for google chromecast (read-only)

Declaration

Swift

public var createChromeCastButton: GCKUICastButton? { get }


                    
                    
                    getChromeCastMiniControlsView

Gets the MiniMediaControlsContainerView view for google chromecast, place this where you want in the app to give the user access to the controls (optional) Visibility will be handled by player logic when needed

Declaration

Swift

public var getChromeCastMiniControlsView: UIView? { get }


                    
                    
                    adMediaWidth

Ad media width in pixels (read-only)

Declaration

Swift

public var adMediaWidth: Int? { get }


                    
                    
                    adMediaHeight

Ad media height in pixels (read-only)

Declaration

Swift

public var adMediaHeight: Int? { get }