Jabber Guest iOS SDK
 All Classes Functions Variables Enumerations Enumerator Properties Modules
CJGuestCall.h
1 //
2 // CJGuestCall.h
3 // JabberGuest
4 //
5 // Copyright (c) 2013 Cisco Systems, Inc. All Rights Reserved.
6 //
7 
8 #import <Foundation/Foundation.h>
9 #import <UIKit/UIKit.h>
10 
11 #import <JabberGuest/CJGuestMediaStatistics.h>
12 #import <JabberGuest/CJGuestVideoLicense.h>
13 
19 @protocol CJGuestInvalidCertCallback <NSObject>
23 - (void)accept;
27 - (void)reject;
28 @end
29 
34 @protocol CJGuestInvalidCertDelegate <NSObject>
35 @optional
47 - (void) onInvalidCert:(NSString*)certFingerprint
48  certSubjectCN:(NSString*)certSubjectCN
49  referenceID:(NSString*)referenceID
50  invalidReason:(NSArray*)invalidReason
51 subjectCertificateData:(NSString*)subjectCertificateData
52 intermediateCACertificateData:(NSArray*)intermediateCACertificateData
53  invalidCertCallback:(id <CJGuestInvalidCertCallback>)invalidCertCallback;
54 @end
55 
56 #pragma mark Notifications
57 
65 extern NSString *const CJGuestCallStateChangeNotification;
71 extern NSString *const CJGuestCallErrorNotification;
76 extern NSString *const CJGuestCallErrorKey;
81 extern NSString *const CJGuestCallSelfVideoResolutionNotification;
106 extern NSString *const CJGuestCallAudioInStateNotification;
111 extern NSString *const CJGuestCallAudioOutStateNotification;
116 extern NSString *const CJGuestCallVideoInStateNotification;
121 extern NSString *const CJGuestCallVideoOutStateNotification;
126 extern NSString *const CJGuestCallOrientationNotification;
131 extern NSString *const CJGuestCallSentDTMFNotification;
135 extern NSString *const CJGuestCallCameraSwitchedNotification;
136 
141 #pragma mark Errors
142 
149 typedef NS_ENUM(NSInteger, CJGuestErrorCode) {
227  /*
228  * The version of the API reported by the Jabber Guest server was invalid.
229  */
230  CJGuestInvalidApiVersionError,
231  /*
232  * The version of the API reported by the Jabber Guest server is not supported with this version of the SDK.
233  */
234  CJGuestUnsupportedApiVersionError
235 };
241 @class CJGuestCall;
242 
255 @interface CJGuestCall : NSObject
256 
267 - (id)init;
268 
269 
277 - (id)initWithServerName:(NSString *)serverName toURI:(NSString *)toURI;
278 
290 @property (nonatomic, readwrite, strong) NSString *serverName;
298 @property (nonatomic, readwrite, strong) NSString *toURI;
299 
312 @property (nonatomic, readwrite, strong) IBOutlet UIImageView * selfView;
313 
317 @property (nonatomic, readonly) CGSize selfSize;
318 
322 @property (nonatomic, readwrite, strong) IBOutlet UIImageView * remoteView;
323 
327 @property (nonatomic, readonly) CGSize remoteSize;
328 
332 @property (nonatomic, readwrite, strong) IBOutlet UIImageView * remotePresoView;
333 
337 @property (nonatomic, readonly) CGSize remotePresoSize;
338 
342 @property (nonatomic, readonly) BOOL remotePresoActive;
343 
347 @property (nonatomic, readonly) BOOL remotePresoStarted;
348 
353 @property (nonatomic, readwrite) UIDeviceOrientation captureOrientation;
354 
355 #if 0
356 
361 - (BOOL)startSelfView;
362 #endif
363 
369 - (void)startSelfView:(CJGuestVideoLicenseCompletion) completion;
370 
375 - (void)stopSelfView;
376 
380 - (void)switchCamera;
381 
391 #if 0
392 
397 - (BOOL)startCall;
398 #endif
399 
405 - (void)startCall:(CJGuestVideoLicenseCompletion) completion;
406 
412 - (void)endCall;
413 
426 typedef NS_ENUM(NSInteger, CJGuestCallStateType) {
431 
437 
446 
453 
461 };
465 @property (nonatomic, readonly) CJGuestCallStateType callState;
466 
479 typedef NS_ENUM(NSInteger, CJGuestMuteStateType) {
484 
490 
495 
500 };
501 
505 @property (nonatomic, readonly) CJGuestMuteStateType audioOutState;
509 @property (nonatomic, readonly) CJGuestMuteStateType videoOutState;
513 @property (nonatomic, readonly) CJGuestMuteStateType audioInState;
517 @property (nonatomic, readonly) CJGuestMuteStateType videoInState;
518 
519 
524 @property (nonatomic, readonly, getter = isAudioOutMuted) BOOL audioOutMuted;
529 @property (nonatomic, readonly, getter = isAudioOutUnmuted) BOOL audioOutUnmuted;
534 @property (nonatomic, readonly, getter = isAudioInMuted) BOOL audioInMuted;
539 @property (nonatomic, readonly, getter = isAudioInUnmuted) BOOL audioInUnmuted;
544 @property (nonatomic, readonly, getter = isVideoOutMuted) BOOL videoOutMuted;
549 @property (nonatomic, readonly, getter = isVideoOutUnmuted) BOOL videoOutUnmuted;
554 @property (nonatomic, readonly, getter = isVideoInMuted) BOOL videoInMuted;
559 @property (nonatomic, readonly, getter = isVideoInUnmuted) BOOL videoInUnmuted;
560 
566 - (void)muteAudioOut;
567 
573 - (void)unmuteAudioOut;
574 
580 - (void)muteVideoOut;
581 
587 - (void)unmuteVideoOut;
588 
600 @property (nonatomic, readonly) NSString *sentDTMF;
601 
607 - (void)sendDTMF:(char)dtmf;
608 
616 - (void)sendDTMFString:(NSString *)dtmfString;
617 
631 @property (nonatomic, readwrite, weak) IBOutlet id <CJGuestInvalidCertDelegate> invalidCertDelegate;
632 
636 @property (nonatomic, readonly, getter = isReady) BOOL ready DEPRECATED_ATTRIBUTE;
637 
641 @property (nonatomic, readonly, weak) CJGuestAudioStatistics * audioStatistics;
642 
646 @property (nonatomic, readonly, weak) CJGuestVideoStatistics * videoStatistics;
647 
652 @property (nonatomic, readonly, weak) NSString * htmlCallStatistics;
653 
654 
664 - (void)audioSetActive:(BOOL) active;
665 
666 
671 typedef NS_ENUM(NSInteger, CJGuestNetworkStatus) {
672  CJGuestNetworkStatus_Unknown,
673  CJGuestNetworkStatus_Online,
674  CJGuestNetworkStatus_Changed,
675  CJGuestNetworkStatus_Offline
676 };
677 
683 - (void)updateNetworkStatus:(CJGuestNetworkStatus) networkStatus;
684 
694 
701 + (NSDictionary *)parseQueryString:(NSString *)query;
702 
707 + (NSArray * )getAllLogs;
708 
715 + (NSString*)stringFromCallState:(CJGuestCallStateType)state;
716 
723 + (NSString*)stringFromMuteState:(CJGuestMuteStateType)state;
724 
725 @end
The destination was busy.
Definition: CJGuestCall.h:189
CJGuestMuteStateType audioInState
Represents the mute state of the audio being received by the local end point.
Definition: CJGuestCall.h:513
CJGuestVideoStatistics * videoStatistics
Provides access to the video stream statistics.
Definition: CJGuestCall.h:646
CJGuestMuteStateType audioOutState
Represents the mute state of the audio being sent to the remote end point.
Definition: CJGuestCall.h:505
CJGuestMuteStateType
Muting or unmuting a media stream requires some coordination between resources, so the state of the m...
Definition: CJGuestCall.h:479
NSString *const CJGuestCallErrorKey
The key for the value in the userInfo dictionary of the NSNotification received from the CJGuestCallE...
Definition: CJGuestCall.mm:63
An http error.
Definition: CJGuestCall.h:217
The ICE negotiation failed.
Definition: CJGuestCall.h:181
The Jabber Guest server encountered a SIP error.
Definition: CJGuestCall.h:153
An undefined error.
Definition: CJGuestCall.h:226
BOOL videoOutUnmuted
Convenience property for determining whether the video output is unmuted.
Definition: CJGuestCall.h:549
BOOL remotePresoActive
The active state of the remotePreso video stream.
Definition: CJGuestCall.h:342
The URI was invalid.
Definition: CJGuestCall.h:161
void muteVideoOut()
Start the process of muting the video output.
Definition: CJGuestCall.mm:904
The media gateway is not defined.
Definition: CJGuestCall.h:173
The URI was not found.
Definition: CJGuestCall.h:201
The server was busy and could no resource allocation failed.
Definition: CJGuestCall.h:177
void endCall()
After calling startCall() to establish the call with the remote endpoint, call this method to end the...
Definition: CJGuestCall.mm:872
void accept()
The delegate calls this to accept the invalid certificate.
This class holds parameters specific to the audio stream of the call.
Definition: CJGuestMediaStatistics.m:64
An invalid call state.
Definition: CJGuestCall.h:193
There was a network error.
Definition: CJGuestCall.h:222
BOOL videoInUnmuted
Convenience property for determining whether the video input is unmuted.
Definition: CJGuestCall.h:559
CJGuestCall * sharedInstance()
This method returns the active call instance.
Definition: CJGuestCall.mm:323
CJGuestCall is not communicating with any remote endpoints and is ready to establish a new communicat...
Definition: CJGuestCall.h:436
The URI was invalid.
Definition: CJGuestCall.h:169
CJGuestCallStateType
This identifies the progress of the call as the call is established with the remote endpoint...
Definition: CJGuestCall.h:426
BOOL audioInMuted
Convenience property for determining whether the audio input is muted.
Definition: CJGuestCall.h:534
A TURN error.
Definition: CJGuestCall.h:197
CGSize selfSize
The size of the self view video image.
Definition: CJGuestCall.h:317
The media stream is muted, no media is passing.
Definition: CJGuestCall.h:483
The URI is not active.
Definition: CJGuestCall.h:205
void stopSelfView()
This will stop capturing video from the local capture device and sending the video to the selfView if...
Definition: CJGuestCall.mm:673
NSString *const CJGuestCallSentDTMFNotification
Register for this event to be notified when a DTMF is sent to the remote endpoint.
Definition: CJGuestCall.mm:61
NSString *const CJGuestCallAudioOutStateNotification
Register for this event to be notified when the audio output mute state changes.
Definition: CJGuestCall.mm:56
NSString *const CJGuestCallErrorNotification
Register for this event to be notified when an error occurs during call processing.
Definition: CJGuestCall.mm:49
UIDeviceOrientation captureOrientation
Indicates the orientation of the device so the video capture can compensate and send the video in the...
Definition: CJGuestCall.h:353
void unmuteAudioOut()
Start the process of unmuting the audio output.
Definition: CJGuestCall.mm:900
This protocol provides a notification if any of the HTTP requests performed by CJGuestCall encounter ...
Definition: CJGuestCall.h:34
BOOL ready DEPRECATED_ATTRIBUTE
Indicates the call is ready and active (it is not disconnected).
Definition: CJGuestCall.h:636
NSString * htmlCallStatistics
Provides an HTML formatted view of the audio and video statistics for display in a web view...
Definition: CJGuestCall.h:652
The media stream is unmuted, media is passing.
Definition: CJGuestCall.h:494
CJGuestCall has not been initialized with a valid server name.
Definition: CJGuestCall.h:430
NSString * serverName
The server name through which we will establish this call.
Definition: CJGuestCall.h:290
This class holds parameters specific to the video stream of the call.
Definition: CJGuestMediaStatistics.h:118
CJGuestCall instance is currently connected to the called party from the URI that it was given...
Definition: CJGuestCall.h:452
CJGuestMuteStateType videoOutState
Represents the mute state of the video being sent to the remote end point.
Definition: CJGuestCall.h:509
NSArray * getAllLogs()
Returns an array of file names corresponding to the log files that exist on the device.
Definition: CJGuestCall.mm:333
CJGuestErrorCode
The error codes for the Jabber Guest Error Domain.
Definition: CJGuestCall.h:149
NSString *const CJGuestCallRemotePresoVideoStartedNotification
Register for this event to be notified when the first frame of the remotePreso video is received...
Definition: CJGuestCall.mm:54
An object implementing this protocol is passed to the CJGuestInvalidCertDelegate. ...
Definition: CJGuestCall.h:19
void switchCamera()
Cycle the local capture device to the next available one.
Definition: CJGuestCall.mm:879
The media stream is transitioning to the muted state and may be passing media.
Definition: CJGuestCall.h:499
id init()
Initializes an instance of CJGuestCall.
Definition: CJGuestCall.mm:354
NSString *const CJGuestCallStateChangeNotification
Register for this event to be notified when the call state changes.
Definition: CJGuestCall.mm:48
NSString * sentDTMF
Provides a string representation of the last DTMF digit sent.
Definition: CJGuestCall.h:600
The media stream is transitioning to the unmuted state and may not be passing media.
Definition: CJGuestCall.h:489
BOOL audioOutUnmuted
Convenience property for determining whether the audio output is unmuted.
Definition: CJGuestCall.h:529
There Jabber Guest server encountered an exception.
Definition: CJGuestCall.h:157
BOOL audioOutMuted
Convenience property for determining whether the audio output is muted.
Definition: CJGuestCall.h:524
CGSize remoteSize
The size of the remote video image.
Definition: CJGuestCall.h:327
NSString *const CJGuestCallRemotePresoVideoActiveNotification
Register for this event to be notified when the active state of the remotePreso view video changes...
Definition: CJGuestCall.mm:53
BOOL videoOutMuted
Convenience property for determining whether the video output is muted.
Definition: CJGuestCall.h:544
NSString *const CJGuestCallVideoInStateNotification
Register for this event to be notified when the video input mute state changes.
Definition: CJGuestCall.mm:57
NSString *const CJGuestCallOrientationNotification
Register for this event to be notified when the orientation of the remote view video changes...
Definition: CJGuestCall.mm:59
NSString *const CJGuestCallRemotePresoVideoResolutionNotification
Register for this event to be notified when the size of the remotePreso view video changes...
Definition: CJGuestCall.mm:52
BOOL videoInMuted
Convenience property for determining whether the video input is muted.
Definition: CJGuestCall.h:554
NSString *const CJGuestCallVideoOutStateNotification
Register for this event to be notified when the video output mute state changes.
Definition: CJGuestCall.mm:58
CJGuestCallStateType callState
Indicates the current state of the call.
Definition: CJGuestCall.h:465
IBOutlet UIImageView * selfView
The selfView will be updated with video from the camera on the device, providing feedback so the user...
Definition: CJGuestCall.h:312
The URI has been disabled.
Definition: CJGuestCall.h:213
NSString *const CJGuestCallCameraSwitchedNotification
Register for this event to be notified when the video capture device is changed.
Definition: CJGuestCall.mm:60
NSString *const CJGuestCallAudioInStateNotification
Register for this event to be notified when the audio input mute state changes.
Definition: CJGuestCall.mm:55
NSString * toURI
The URI of the remote end point to which the call should be established.
Definition: CJGuestCall.h:298
CJGuestAudioStatistics * audioStatistics
Provides access to the audio stream statistics.
Definition: CJGuestCall.h:641
void muteAudioOut()
Start the process of muting the audio output.
Definition: CJGuestCall.mm:896
IBOutlet UIImageView * remotePresoView
This will be updated with video sent from the remotePreso endpoint of the call.
Definition: CJGuestCall.h:332
The URI has expired.
Definition: CJGuestCall.h:209
NSString *const CJGuestCallRemoteVideoResolutionNotification
Register for this event to be notified when the size of the remote view video changes.
Definition: CJGuestCall.mm:51
NSString *const CJGuestCallSelfVideoResolutionNotification
Register for this event to be notified when the size of the self view video changes.
Definition: CJGuestCall.mm:50
IBOutlet id< CJGuestInvalidCertDelegate > invalidCertDelegate
This delegate is called when HTTP requests encounter problems verifying the certificate for a web sit...
Definition: CJGuestCall.h:631
There was a networking error between the device and the server.
Definition: CJGuestCall.h:165
CJGuestMuteStateType videoInState
Represents the mute state of the video being received by the local end point.
Definition: CJGuestCall.h:517
CJGuestCall is trying to connect a call to the called party from the URI that it was given...
Definition: CJGuestCall.h:445
CJGuestCall instance is either attempting to end an active call at the request of the device user...
Definition: CJGuestCall.h:460
BOOL remotePresoStarted
The active state of the remotePreso video stream.
Definition: CJGuestCall.h:347
This is the main class of the Jabber Guest iOS SDK.
Definition: CJGuestCall.mm:313
IBOutlet UIImageView * remoteView
This will be updated with video sent from the remote endpoint of the call.
Definition: CJGuestCall.h:322
BOOL audioInUnmuted
Convenience property for determining whether the audio input is unmuted.
Definition: CJGuestCall.h:539
There was an error in the SIP configuration.
Definition: CJGuestCall.h:185
CGSize remotePresoSize
The size of the remotePreso video image.
Definition: CJGuestCall.h:337
void reject()
The delegate calls this to reject the invalid certificate.
void unmuteVideoOut()
Start the process of unmuting the video output.
Definition: CJGuestCall.mm:908