BJNVideoObjc

@objc(BJNVideo)
public class BJNVideoObjc : NSObject

BJNVideoObjc(BJNVideo in Objective C) is an Objective C compatible wrapper around BJNVideo object. This class is only available to use in Objective C classes and not in Swift.

It can be initialized as,

BJNVideo *video = [[BJNVideo alloc] init];

or

BJNVideo *video = [[BJNVideo alloc] initWithMaxVideoBandwidth:nil];

Delegate Properties

Initialization

  • Creates a video instance and initializes all properties. This function uses default value for maxVideoBandwidth as nil.

    Declaration

    Swift

    @objc
public override init()

  • Creates a video instance and initializes all properties.

    Declaration

    Swift

    @objc
public init(maxVideoBandwidth: NSNumber?)

    Parameters

    maxVideoBandwidth

    Optional field. The maximum video bitrate that should be sent. Unit is kiloBitsPerSecond.

BJNMeeting Properties and Methods

  • The join function connects the client into a BlueJeans meeting room in the cloud. This call will not schedule a meeting, so the meeting must have already been scheduled/exist. When joining the (existing) meeting the client will either see participants, or the screen shown to the first participant.

    Declaration

    Swift

    @objc
public func join(meetingID id: String, passcode: String?, displayName: String, useBlueJeansStaging: Bool,
                 maxVideoBandwidth: NSNumber?, onSuccess: @escaping CompletionBlock, onFailure: @escaping CompletionBlock)

    Parameters

    id

    The dialable BlueJeans meeting ID number.
    passcode

    The passcode field serves multiple purposes. To manage the BlueJeans meeting, populate this field with the Moderator Code. To provide an extra level of security, a meeting may have assigned a Security pass code value. Lastly, if there is no code assigned, set this field to null or empty-string.
    displayName

    The name of this client as it would appear in the meeting roster.
    useBlueJeansStaging

    Represents whether the client is connecting to the production or staging cloud services at BlueJeans.
    maxVideoBandwidth

    Optional field. The maximum video bitrate that should be sent. Unit is kiloBitsPerSecond.
    onSuccess

    Callback if joinMeeting succeeded.
    onFailure

    Callback if there was a problem encountered.

  • The join function connects the client into a BlueJeans meeting room in the cloud. This call will not schedule a meeting, so the meeting must have already been scheduled/exist. When joining the (existing) meeting the client will either see participants, or the screen shown to the first participant.

    This function uses default values for useBlueJeansStaging and maxVideoBandwidth as false and nil respectively.

    Declaration

    Swift

    @objc
public func join(meetingID id: String, passcode: String?, displayName: String, onSuccess: @escaping CompletionBlock, onFailure: @escaping CompletionBlock)

    Parameters

    id

    The dialable BlueJeans meeting ID number.
    passcode

    The passcode field serves multiple purposes. To manage the BlueJeans meeting, populate this field with the Moderator Code. To provide an extra level of security, a meeting may have assigned a Security pass code value. Lastly, if there is no code assigned, set this field to null or empty-string.
    displayName

    The name of this client as it would appear in the meeting roster.
    onSuccess

    Callback if joinMeeting succeeded.
    onFailure

    Callback if there was a problem encountered.

  • The leave function disconnects this client session from the BlueJeans meeting room in the cloud. If the overload function is called with the ejectAndEnd parameter, the client can request BlueJeans to eject any remaining users and end the meeting session.

    Declaration

    Swift

    @objc
public func leave(ejectAndEnd: Bool)

    Parameters

    ejectAndEnd

    If true, eject any users in meeting room and then end the meeting session.

  • The leave function disconnects this client session from the BlueJeans meeting room in the cloud.

    This function uses default value for ejectAndEnd as false.

    Declaration

    Swift

    @objc
public func leave()

BJNAdministrative Properties and Methods

  • Represents the current state of connection between the client application, and a BlueJeans meeting.

    Any change to the connection state, with the exception of initialization, will generate an event callback via the didChangeConnectionState delegate method.

    Possible values are idle, connecting, connected, disconnected, reconnecting.

    Declaration

    Swift

    @objc
public var connectionState: ConnectionState { get }

  • Represents the extent of logging detail provided by the SDK in order to diagnose operations.

    Any change to the loggingMode, with the exception of initialization, will generate an event callback via the didChangeLoggingMode delegate method.

    Possible values are debug, info, warning, error, verbose.

    Declaration

    Swift

    @objc
public var loggingMode: LoggingMode { get set }

  • A boolean variable, if true, represents that the BlueJeans meeting has a collaborative screen sharing session running.

    Any change to the screen share state, with the exception of initialization, will generate an event callback via the didChangeReceivingScreenShare delegate method.

    Declaration

    Swift

    @objc
public var receivingScreenShare: Bool { get }

  • A boolean variable, if true, indicates that the SDK will turn on the local camera to allow the user to see themselves before connecting into a video meeting.

    Any change to the screen share state, with the exception of initialization, will generate an event callback via the didEnableSelfVideoPreview delegate method.

    Declaration

    Swift

    @objc
public var enableSelfVideoPreview: Bool { get set }

  • Represents the current connection-state of the client application’s video media, and the meeting in the BlueJeans meeting.

    Any change to the connection state, with the exception of initialization, will generate an event callback via the didChangeVideoState delegate method.

    Possible values are active, inactiveOnlyParticipant, inactiveNoOneHasVideo, inactiveNeedsModerator, inactiveDisconnected.

    Declaration

    Swift

    @objc
public var videoState: VideoState { get }

BJNParticipants Properties and Methods

  • Represents the current state of microphone audio. The variable may be updated(set) by the client application, or by messages from the backend infrastructure.

    Any update, with the exception of initialization, will generate an event callback via the didMuteAudio delegate method.

    Declaration

    Swift

    @objc
public var audioMuted: Bool { get set }

  • Represents the current state of video display. The variable may be updated(set) by the client application, or by messages from the backend infrastructure.

    Any update, with the exception of initialization,will generate an event callback via the didMuteVideo delegate method.

    Declaration

    Swift

    @objc
public var videoMuted: Bool { get set }

BJNMediaDevices Properties and Methods

  • Represents the current local camera device selected. Use selectCameraDevice(:) for selecting a local camera device.

    Any change to the camera device, with the exception of initialization, will generate an event callback via the didChangeCameraDevice delegate method.

    Possible values are front, back.

    Declaration

    Swift

    @objc
public var cameraDevice: CameraDevice { get }

  • Engages the OS resident UI and method for Audio device selection.

    Declaration

    Swift

    @objc
public func createAudioDeviceSelectionPresenterView() -> UIView?

    Return Value

    Returns a UIView or nil. This can be added on a view and used as Audio Device Picker.

  • Returns a UIView instance mapped to the view responsible for rendering the shared collaboration view coming from the BlueJeans Cloud.

    Declaration

    Swift

    @objc
public func getContentShareInstance() -> UIView?

    Return Value

    Returns a UIView or nil.

  • Returns a UIView instance mapped to the view responsible for rendering the video coming from the BlueJeans cloud.

    Declaration

    Swift

    @objc
public func getRemoteVideoInstance() -> UIView?

    Return Value

    Returns a UIView or nil.

  • Selects which local camera device to use.

    Declaration

    Swift

    @objc
public func selectCameraDevice(_ cameraDevice: CameraDevice)

    Parameters

    cameraDevice

    camera device value to be selected. Possible values are front, back.

  • Returns a UIView instance mapped to the view responsible for rendering the video coming from the device’s internal camera(s).

    Declaration

    Swift

    @objc
public func getSelfViewInstance() -> UIView?

    Return Value

    Returns a UIView or nil.