BlackBerry Spark Communications Services for iOS  1.9.0
BBMMediaTypes.h File Reference

Error codes, states, and other types for BBMMediaManager. More...

Enumerations

enum  BBMCallType { kMediaCall, kDataCall }
 The type of call - Media or Data. More...
 
enum  MediaMode { kNone, kVideo, kVoice }
 The available media modes. More...
 
enum  CameraOperation { kUnspecifiedCameraOperation, kActivateCamera, kDeactivateCamera, kSwitchCamera }
 The available camera operations. More...
 
enum  BBMDataConnectionState {
  kDataConnectionStateUnknown, kDataConnectionOffering, kDataConnectionAccepted, kDataConnectionReady,
  kDataConnectionEnded, kDataConnectionFailed
}
 State of a data connection. More...
 
enum  BBMEnabledState { BBMEEnabled, BBMEDisabled }
 Enabled or disabled state. More...
 
enum  BBMCallQuality { kCallQualityUnknown, kCallQualityGood, kCallQualityModerate, kCallQualityPoor }
 Call quality values. More...
 
enum  BBMSecureCallStatus {
  kCallStatusUnknown = 0, kSecureCallStatusUnknown = 0, kCallStatusInactive = 1, kSecureCallStatusNotSecure = 1,
  kCallStatusActive = 2, kSecureCallStatusSecure = 2
}
 Call security status values. More...
 
enum  BBMCallLogType {
  kCallLogNone, kCallLogEnded, kCallLogDisconnected, kCallLogMissed,
  kCallLogBusy, kCallLogUnavailable, kCallLogCancelled, kCallLogDeclined,
  kCallLogConnectionError, kCallLogCompletedElsewhere, kCallLogDeclinedElsewhere
}
 Call log types for completed calls. More...
 
enum  BBMCallState {
  kCallStateIdle, kCallStateOffering, kCallStateAccepted, kCallStateConnected,
  kCallStateInitialized, kCallStateProceeding, kCallStateRingback, kCallStateDisconnected,
  kCallStateInitiated
}
 Call states. More...
 
enum  BBMMediaError {
  kMediaErrorNoError, kMediaErrorInvalidState, kMediaErrorInvalidCallId, kMediaErrorCellCallingDisabled,
  kMediaErrorServiceUnavailable, kMediaErrorInvalidCommand, kMediaErrorUnknownUser, kMediaErrorUnknownError
}
 Media error codes. More...
 
enum  BBMMediaFailureReason {
  kMediaFailureNoFailure, kMediaFailureIceCheckFailed, kMediaFailureNetworkUnavailable, kMediaFailureCallingOverCellDisabled,
  kMediaFailureNoMedia, kMediaFailureUserNotFound, kMediaFailureTimeout, kMediaFailureUserUnavailable,
  kMediaFailureUserBusy, kMediaFailureCallDeclined, kMediaFailureNetworkError, kMediaFailureAudioFailure,
  kMediaFailureKeyError, kMediaFailureVoiceUnsupported, kMediaFailureKeyTimeout, kMediaFailureUserBlocked,
  kMediaFailureCompletedElsewhere, kMediaFailureDeclinedElsewhere, kMediaFailureUnknownError
}
 Media failure reason. More...
 
enum  BBMMediaState {
  kMediaStateNone, kMediaStateInactive, kMediaStateActive, kMediaStateSendOnly,
  kMediaStateReceiveOnly, kMediaStateRecoveryPending, kMediaStateRecoveryStarted
}
 Media states. More...
 

Detailed Description

Error codes, states, and other types for BBMMediaManager.

Since
R3

Enumeration Type Documentation

◆ BBMCallLogType

Call log types for completed calls.

Since
R3
Enumerator
kCallLogNone 

No call log should be generated for this call.

kCallLogEnded 

Indicates that the call was ended normally.

kCallLogDisconnected 

Indicates that the call was disconnected.

kCallLogMissed 

Indicates that the call was missed.

kCallLogBusy 

Indicates that the contact was busy.

kCallLogUnavailable 

Indicates that the contact was unavailable.

kCallLogCancelled 

Indicates that the call was canceled before the contact accepted.

kCallLogDeclined 

Indicates that the call was declined.

kCallLogConnectionError 

Indicates that an error occurred connecting the call.

kCallLogCompletedElsewhere 

Indicates that the call was completed elsewhere.

kCallLogDeclinedElsewhere 

Indicates that the call was declined elsewhere.

◆ BBMCallQuality

Call quality values.

Since
R3
Enumerator
kCallQualityUnknown 

Unknown call quality.

kCallQualityGood 

Good (high) call quality.

kCallQualityModerate 

Moderate call quality.

kCallQualityPoor 

Poor call quality.

◆ BBMCallState

Call states.

Incoming call state transition: kCallStateOffering->kCallStateAccepted->kCallStateConnected->kCallStateDisconnected
Outgoing call state transition: kCallStateInitialized->kCallStateProceeding->kCallStateRingback->kCallStateConnected->kCallStateDisconnected

Since
R3
Enumerator
kCallStateIdle 

The initial call state when there is no call in progress.

kCallStateOffering 

Invitation is received for an incoming call, and the process has started to determine if the call can be accepted.

kCallStateAccepted 

An incoming call is accepted, and the device is ringing. The incoming call should be presented to the user.

kCallStateConnected 

Call recipient has answered the call, and the call is connected from a signalling perspective. Note: This state does not imply that media is flowing.

kCallStateInitialized 

Request received to start an outgoing call.

kCallStateProceeding 

Invitation sent to the other party requesting a call.

kCallStateRingback 

Ringing received from the other party.

kCallStateDisconnected 

Call terminated.

kCallStateInitiated 

Request received to answer an incoming call.

◆ BBMCallType

The type of call - Media or Data.

Since
R5

◆ BBMDataConnectionState

State of a data connection.

Since
5

◆ BBMEnabledState

Enabled or disabled state.

Since
R3
Enumerator
BBMEEnabled 

BBMEEnabled The feature is enabled.

BBMEDisabled 

BBMEDisabled The feature is disabled.

◆ BBMMediaError

Media error codes.

Since
R3
Enumerator
kMediaErrorNoError 

No Error.

kMediaErrorInvalidState 

Call state is no valid for requested command.

kMediaErrorInvalidCallId 

Call ID does not match current call ID.

kMediaErrorCellCallingDisabled 

Calling over cellular connection has been disabled by the user.

kMediaErrorServiceUnavailable 

Service is not connected.

kMediaErrorInvalidCommand 

Supplied command or parameters are invalid.

kMediaErrorUnknownUser 

The regId provided does not match any known user (and/or the user lookup failed)

kMediaErrorUnknownError 

An unknown error has occurred.

◆ BBMMediaFailureReason

Media failure reason.

Since
R3
Enumerator
kMediaFailureNoFailure 

No Failure.

kMediaFailureIceCheckFailed 

Failure to negotiate a media path.

kMediaFailureNetworkUnavailable 

Network Unavailable,.

kMediaFailureCallingOverCellDisabled 

Calling over cellular has been disabled.

kMediaFailureNoMedia 

Media initialization failure.

kMediaFailureUserNotFound 

Unable to find the remote user.

kMediaFailureTimeout 

Call request timed out.

kMediaFailureUserUnavailable 

Callee is unavailable.

kMediaFailureUserBusy 

Callee is busy.

kMediaFailureCallDeclined 

Callee has declined the call.

kMediaFailureNetworkError 

General network error.

kMediaFailureAudioFailure 

Audio Failure.

kMediaFailureKeyError 

Unable to find the encryption keys for the callee.

kMediaFailureVoiceUnsupported 

Secure calling is not supported.

kMediaFailureKeyTimeout 

Timeout loading the keys for the callee.

kMediaFailureUserBlocked 

Request to call the user not permitted.

kMediaFailureCompletedElsewhere 

Call was completed elsewhere.

kMediaFailureDeclinedElsewhere 

Call was declined elsewhere.

kMediaFailureUnknownError 

Generic unknown error.

◆ BBMMediaState

Media states.

Since
R3
Enumerator
kMediaStateNone 

No current media state defined.

kMediaStateInactive 

Media is inactive.

kMediaStateActive 

Media is actively flowing in both direction.

kMediaStateSendOnly 

Media is sending/transmitting only.

kMediaStateReceiveOnly 

Media is receiving only.

kMediaStateRecoveryPending 

Media issues detected, call recovery is pending.

kMediaStateRecoveryStarted 

Call recovery is underway.

◆ BBMSecureCallStatus

Call security status values.

Since
R4
Enumerator
kCallStatusUnknown 

The status of the key exchange is unknown (Deprecated, use kSecureCallStatusUnknown)

kSecureCallStatusUnknown 

The status of the key exchange is unknown.

kCallStatusInactive 

The call is not secure (Deprecated, use kSecureCallStatusNotSecure)

kSecureCallStatusNotSecure 

The call is not secure.

kCallStatusActive 

The call is secure (Deprecated, use kSecureCallStatusSecure)

kSecureCallStatusSecure 

The call is secure.

◆ CameraOperation

The available camera operations.

Since
R10
Enumerator
kUnspecifiedCameraOperation 

Unspecified operation.

kActivateCamera 

Camera activated.

kDeactivateCamera 

Camera deactivate.

kSwitchCamera 

Switch camera.

◆ MediaMode

enum MediaMode

The available media modes.

Since
R3
Enumerator
kNone 

Unspecified media mode.

kVideo 

Video chat.

kVoice 

Voice chat.