Jabber Guest iOS SDK
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 
36 @optional
41 -(void) serverConfiguraionDidRetriveWithScheduledCallInfo:(NSInteger)secs;
42 
47 
52 @end
53 
58 @protocol CJGuestInvalidCertDelegate <NSObject>
59 @optional
71 - (void) onInvalidCert:(NSString*)certFingerprint
72  certSubjectCN:(NSString*)certSubjectCN
73  referenceID:(NSString*)referenceID
74  invalidReason:(NSArray*)invalidReason
75 subjectCertificateData:(NSString*)subjectCertificateData
76 intermediateCACertificateData:(NSArray*)intermediateCACertificateData
77  invalidCertCallback:(id <CJGuestInvalidCertCallback>)invalidCertCallback;
78 @end
79 
80 #pragma mark Notifications
81 
89 extern NSString *const CJGuestCallStateChangeNotification;
95 extern NSString *const CJGuestCallErrorNotification;
100 extern NSString *const CJGuestCallErrorKey;
105 extern NSString *const CJGuestCallSelfVideoResolutionNotification;
110 extern NSString *const CJGuestCallRemoteVideoResolutionNotification;
120 extern NSString *const CJGuestCallRemotePresoVideoActiveNotification;
125 extern NSString *const CJGuestCallSelfVideoActiveNotification;
135 extern NSString *const CJGuestCallAudioInStateNotification;
140 extern NSString *const CJGuestCallAudioOutStateNotification;
145 extern NSString *const CJGuestCallVideoInStateNotification;
150 extern NSString *const CJGuestCallVideoOutStateNotification;
155 extern NSString *const CJGuestCallOrientationNotification;
160 extern NSString *const CJGuestCallSentDTMFNotification;
164 extern NSString *const CJGuestCallCameraSwitchedNotification;
168 extern NSString *const CJGuestCallServerVersionNotification;
169 
174 #pragma mark Errors
175 
182 typedef NS_ENUM(NSInteger, CJGuestErrorCode) {
260  /*
261  * The version of the API reported by the Jabber Guest server was invalid.
262  */
263  CJGuestInvalidApiVersionError,
264  /*
265  * The version of the API reported by the Jabber Guest server is not supported with this version of the SDK.
266  */
267  CJGuestUnsupportedApiVersionError
268 };
274 @class CJGuestCall;
275 
289 @interface CJGuestCall : NSObject
290 
301 - (id)init;
302 
303 
311 - (id)initWithServerName:(NSString *)serverName toURI:(NSString *)toURI;
312 
324 @property (nonatomic, readwrite, strong) NSString *serverName;
332 @property (nonatomic, readwrite, strong) NSString *toURI;
336 @property (nonatomic, readwrite, strong) NSString *fullServerUrl;
337 
350 @property (nonatomic, readwrite, strong) IBOutlet UIImageView * selfView;
351 
355 @property (nonatomic, readonly) CGSize selfSize;
356 
360 @property (nonatomic, readwrite, strong) IBOutlet UIImageView * remoteView;
361 
365 @property (nonatomic, readonly) CGSize remoteSize;
366 
370 @property (nonatomic, readwrite, strong) IBOutlet UIImageView * remotePresoView;
371 
375 @property (nonatomic, readonly) CGSize remotePresoSize;
376 
380 @property (nonatomic, readonly) BOOL remotePresoActive;
381 
385 @property (nonatomic, readonly) BOOL selfVideoActive;
386 
390 @property (nonatomic, readonly) BOOL remotePresoStarted;
391 
396 @property (nonatomic, readwrite) UIInterfaceOrientation captureOrientation;
397 
398 #if 0
399 
404 - (BOOL)startSelfView;
405 #endif
406 
412 - (void)startSelfView:(CJGuestVideoLicenseCompletion) completion;
413 
418 - (void)stopSelfView;
419 
423 - (void)switchCamera;
424 
434 #if 0
435 
440 - (BOOL)startCall;
441 #endif
442 
448 - (void)startCall:(CJGuestVideoLicenseCompletion) completion;
449 
455 - (void)endCall;
456 
460 - (void)cancelAutoStartCall;
461 
474 typedef NS_ENUM(NSInteger, CJGuestCallStateType) {
479 
485 
494 
501 
509 };
513 @property (nonatomic, readonly) CJGuestCallStateType callState;
514 
527 typedef NS_ENUM(NSInteger, CJGuestMuteStateType) {
532 
538 
543 
548 };
549 
553 @property (nonatomic, readonly) CJGuestMuteStateType audioOutState;
557 @property (nonatomic, readonly) CJGuestMuteStateType videoOutState;
561 @property (nonatomic, readonly) CJGuestMuteStateType audioInState;
565 @property (nonatomic, readonly) CJGuestMuteStateType videoInState;
566 
567 
572 @property (nonatomic, readonly, getter = isAudioOutMuted) BOOL audioOutMuted;
577 @property (nonatomic, readonly, getter = isAudioOutUnmuted) BOOL audioOutUnmuted;
582 @property (nonatomic, readonly, getter = isAudioInMuted) BOOL audioInMuted;
587 @property (nonatomic, readonly, getter = isAudioInUnmuted) BOOL audioInUnmuted;
592 @property (nonatomic, readonly, getter = isVideoOutMuted) BOOL videoOutMuted;
597 @property (nonatomic, readonly, getter = isVideoOutUnmuted) BOOL videoOutUnmuted;
601 @property (nonatomic, readonly, getter = isVideoControlEnabled) BOOL videoControlEnabled;
606 @property (nonatomic, readonly, getter = isVideoInMuted) BOOL videoInMuted;
611 @property (nonatomic, readonly, getter = isVideoInUnmuted) BOOL videoInUnmuted;
612 
618 - (void)muteAudioOut;
619 
625 - (void)unmuteAudioOut;
626 
632 - (void)muteVideoOut;
633 
639 - (void)unmuteVideoOut;
640 
652 @property (nonatomic, readonly) NSString *sentDTMF;
653 
659 - (void)sendDTMF:(char)dtmf;
660 
668 - (void)sendDTMFString:(NSString *)dtmfString;
669 
683 @property (nonatomic, readwrite, weak) IBOutlet id <CJGuestInvalidCertDelegate> invalidCertDelegate;
684 
690 @property (nonatomic, readwrite, weak) IBOutlet id <CJGuestServerConfiguraionCallDelegate> autoStartCallDelegate;
691 
695 @property (nonatomic, readonly, getter = isReady) BOOL ready DEPRECATED_ATTRIBUTE;
696 
700 @property (nonatomic, readonly, weak) CJGuestAudioStatistics * audioStatistics;
701 
705 @property (nonatomic, readonly, weak) CJGuestVideoStatistics * videoStatistics;
706 
710 @property (nonatomic, readonly, weak) CJGuestVideoStatistics * shareStatistics;
711 
712 
717 @property (nonatomic, readonly, weak) NSString * htmlCallStatistics;
718 
728 - (void)audioSetActive:(BOOL) active;
729 
730 
735 typedef NS_ENUM(NSInteger, CJGuestNetworkStatus) {
736  CJGuestNetworkStatus_Unknown,
737  CJGuestNetworkStatus_Online,
738  CJGuestNetworkStatus_Changed,
739  CJGuestNetworkStatus_Offline
740 };
741 
747 - (void)updateNetworkStatus:(CJGuestNetworkStatus) networkStatus;
748 
758 
765 + (NSDictionary *)parseQueryString:(NSString *)query;
766 
771 + (NSArray * )getAllLogs;
772 
779 + (NSString*)stringFromCallState:(CJGuestCallStateType)state;
780 
787 + (NSString*)stringFromMuteState:(CJGuestMuteStateType)state;
788 
789 
794 + (void)setGlobalLoggingEnabled:(BOOL)enabled;
795 
796 @end
The destination was busy.
Definition: CJGuestCall.h:222
CJGuestMuteStateType audioInState
Represents the mute state of the audio being received by the local end point.
Definition: CJGuestCall.h:561
CJGuestVideoStatistics * videoStatistics
Provides access to the video stream statistics.
Definition: CJGuestCall.h:705
CJGuestMuteStateType audioOutState
Represents the mute state of the audio being sent to the remote end point.
Definition: CJGuestCall.h:553
CJGuestMuteStateType
Muting or unmuting a media stream requires some coordination between resources, so the state of the m...
Definition: CJGuestCall.h:527
NSString *const CJGuestCallErrorKey
The key for the value in the userInfo dictionary of the NSNotification received from the CJGuestCallE...
Definition: CJGuestCall.mm:66
An http error.
Definition: CJGuestCall.h:250
The ICE negotiation failed.
Definition: CJGuestCall.h:214
NSString * fullServerUrl
The whole url including server name, protocol, toURI and also some prefeteched configuration from ser...
Definition: CJGuestCall.h:336
The Jabber Guest server encountered a SIP error.
Definition: CJGuestCall.h:186
An undefined error.
Definition: CJGuestCall.h:259
BOOL videoOutUnmuted
Convenience property for determining whether the video output is unmuted.
Definition: CJGuestCall.h:597
BOOL remotePresoActive
The active state of the remotePreso video stream.
Definition: CJGuestCall.h:380
The URI was invalid.
Definition: CJGuestCall.h:194
void muteVideoOut()
Start the process of muting the video output.
Definition: CJGuestCall.mm:963
The media gateway is not defined.
Definition: CJGuestCall.h:206
The URI was not found.
Definition: CJGuestCall.h:234
The server was busy and could no resource allocation failed.
Definition: CJGuestCall.h:210
void endCall()
After calling startCall() to establish the call with the remote endpoint, call this method to end the...
Definition: CJGuestCall.mm:925
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:226
There was a network error.
Definition: CJGuestCall.h:255
BOOL videoInUnmuted
Convenience property for determining whether the video input is unmuted.
Definition: CJGuestCall.h:611
CJGuestCall * sharedInstance()
This method returns the active call instance.
Definition: CJGuestCall.mm:327
CJGuestCall is not communicating with any remote endpoints and is ready to establish a new communicat...
Definition: CJGuestCall.h:484
The URI was invalid.
Definition: CJGuestCall.h:202
CJGuestCallStateType
This identifies the progress of the call as the call is established with the remote endpoint...
Definition: CJGuestCall.h:474
BOOL audioInMuted
Convenience property for determining whether the audio input is muted.
Definition: CJGuestCall.h:582
A TURN error.
Definition: CJGuestCall.h:230
CGSize selfSize
The size of the self view video image.
Definition: CJGuestCall.h:355
The media stream is muted, no media is passing.
Definition: CJGuestCall.h:531
The URI is not active.
Definition: CJGuestCall.h:238
An object implementing this potocol is passed to CJGuestServerConfiguraionCallDelegate.
Definition: CJGuestCall.h:35
void stopSelfView()
This will stop capturing video from the local capture device and sending the video to the selfView if...
Definition: CJGuestCall.mm:695
NSString *const CJGuestCallSentDTMFNotification
Register for this event to be notified when a DTMF is sent to the remote endpoint.
Definition: CJGuestCall.mm:63
NSString *const CJGuestCallAudioOutStateNotification
Register for this event to be notified when the audio output mute state changes.
Definition: CJGuestCall.mm:58
NSString *const CJGuestCallErrorNotification
Register for this event to be notified when an error occurs during call processing.
Definition: CJGuestCall.mm:50
void unmuteAudioOut()
Start the process of unmuting the audio output.
Definition: CJGuestCall.mm:959
This protocol provides a notification if any of the HTTP requests performed by CJGuestCall encounter ...
Definition: CJGuestCall.h:58
BOOL ready DEPRECATED_ATTRIBUTE
Indicates the call is ready and active (it is not disconnected).
Definition: CJGuestCall.h:695
NSString * htmlCallStatistics
Provides an HTML formatted view of the audio and video statistics for display in a web view...
Definition: CJGuestCall.h:717
The media stream is unmuted, media is passing.
Definition: CJGuestCall.h:542
CJGuestCall has not been initialized with a valid server name.
Definition: CJGuestCall.h:478
void cancelAutoStartCall()
When a automatic-start call is scheduled, call this to cancel the scheduled call. ...
Definition: CJGuestCall.mm:932
NSString * serverName
The server name through which we will establish this call.
Definition: CJGuestCall.h:324
CJGuestCall instance is currently connected to the called party from the URI that it was given...
Definition: CJGuestCall.h:500
CJGuestMuteStateType videoOutState
Represents the mute state of the video being sent to the remote end point.
Definition: CJGuestCall.h:557
NSArray * getAllLogs()
Returns an array of file names corresponding to the log files that exist on the device.
Definition: CJGuestCall.mm:337
CJGuestErrorCode
The error codes for the Jabber Guest Error Domain.
Definition: CJGuestCall.h:182
NSString *const CJGuestCallRemotePresoVideoStartedNotification
Register for this event to be notified when the first frame of the remotePreso video is received...
Definition: CJGuestCall.mm:56
An object implementing this protocol is passed to the CJGuestInvalidCertDelegate. ...
Definition: CJGuestCall.h:19
BOOL selfVideoActive
The active state of the self video stream.
Definition: CJGuestCall.h:385
void switchCamera()
Cycle the local capture device to the next available one.
Definition: CJGuestCall.mm:938
The media stream is transitioning to the muted state and may be passing media.
Definition: CJGuestCall.h:547
id init()
Initializes an instance of CJGuestCall.
Definition: CJGuestCall.mm:358
NSString *const CJGuestCallStateChangeNotification
Register for this event to be notified when the call state changes.
Definition: CJGuestCall.mm:49
NSString * sentDTMF
Provides a string representation of the last DTMF digit sent.
Definition: CJGuestCall.h:652
The media stream is transitioning to the unmuted state and may not be passing media.
Definition: CJGuestCall.h:537
This class holds parameters specific to the video stream of the call.
Definition: CJGuestMediaStatistics.m:75
void scheduledCallDidExecute()
This is called when the scheduled automatic-start call is executed.
BOOL audioOutUnmuted
Convenience property for determining whether the audio output is unmuted.
Definition: CJGuestCall.h:577
There Jabber Guest server encountered an exception.
Definition: CJGuestCall.h:190
BOOL audioOutMuted
Convenience property for determining whether the audio output is muted.
Definition: CJGuestCall.h:572
NSString *const CJGuestCallServerVersionNotification
Register for this event to be notified of the server version.
Definition: CJGuestCall.mm:64
CGSize remoteSize
The size of the remote video image.
Definition: CJGuestCall.h:365
NSString *const CJGuestCallRemotePresoVideoActiveNotification
Register for this event to be notified when the active state of the remotePreso view video changes...
Definition: CJGuestCall.mm:54
BOOL videoOutMuted
Convenience property for determining whether the video output is muted.
Definition: CJGuestCall.h:592
NSString *const CJGuestCallVideoInStateNotification
Register for this event to be notified when the video input mute state changes.
Definition: CJGuestCall.mm:59
void allServerConfigurationDidRetrieve()
This is called to indicate all the server configuration is retrieved.
NSString *const CJGuestCallOrientationNotification
Register for this event to be notified when the orientation of the remote view video changes...
Definition: CJGuestCall.mm:61
NSString *const CJGuestCallRemotePresoVideoResolutionNotification
Register for this event to be notified when the size of the remotePreso view video changes...
Definition: CJGuestCall.mm:53
BOOL videoInMuted
Convenience property for determining whether the video input is muted.
Definition: CJGuestCall.h:606
NSString *const CJGuestCallSelfVideoActiveNotification
Register for this event to be notified when the active state of the self view video changes...
Definition: CJGuestCall.mm:55
NSString *const CJGuestCallVideoOutStateNotification
Register for this event to be notified when the video output mute state changes.
Definition: CJGuestCall.mm:60
CJGuestCallStateType callState
Indicates the current state of the call.
Definition: CJGuestCall.h:513
IBOutlet UIImageView * selfView
The selfView will be updated with video from the camera on the device, providing feedback so the user...
Definition: CJGuestCall.h:350
The URI has been disabled.
Definition: CJGuestCall.h:246
NSString *const CJGuestCallCameraSwitchedNotification
Register for this event to be notified when the video capture device is changed.
Definition: CJGuestCall.mm:62
NSString *const CJGuestCallAudioInStateNotification
Register for this event to be notified when the audio input mute state changes.
Definition: CJGuestCall.mm:57
NSString * toURI
The URI of the remote end point to which the call should be established.
Definition: CJGuestCall.h:332
CJGuestAudioStatistics * audioStatistics
Provides access to the audio stream statistics.
Definition: CJGuestCall.h:700
void muteAudioOut()
Start the process of muting the audio output.
Definition: CJGuestCall.mm:955
CJGuestVideoStatistics * shareStatistics
Provides access to the share stream statistics.
Definition: CJGuestCall.h:710
IBOutlet id< CJGuestServerConfiguraionCallDelegate > autoStartCallDelegate
This delegate is called when server enable automatically start call feature.
Definition: CJGuestCall.h:690
IBOutlet UIImageView * remotePresoView
This will be updated with video sent from the remotePreso endpoint of the call.
Definition: CJGuestCall.h:370
The URI has expired.
Definition: CJGuestCall.h:242
NSString *const CJGuestCallRemoteVideoResolutionNotification
Register for this event to be notified when the size of the remote view video changes.
Definition: CJGuestCall.mm:52
NSString *const CJGuestCallSelfVideoResolutionNotification
Register for this event to be notified when the size of the self view video changes.
Definition: CJGuestCall.mm:51
IBOutlet id< CJGuestInvalidCertDelegate > invalidCertDelegate
This delegate is called when HTTP requests encounter problems verifying the certificate for a web sit...
Definition: CJGuestCall.h:683
There was a networking error between the device and the server.
Definition: CJGuestCall.h:198
CJGuestMuteStateType videoInState
Represents the mute state of the video being received by the local end point.
Definition: CJGuestCall.h:565
CJGuestCall is trying to connect a call to the called party from the URI that it was given...
Definition: CJGuestCall.h:493
CJGuestCall instance is either attempting to end an active call at the request of the device user...
Definition: CJGuestCall.h:508
BOOL remotePresoStarted
The active state of the remotePreso video stream.
Definition: CJGuestCall.h:390
This is the main class of the Jabber Guest iOS SDK.
Definition: CJGuestCall.mm:317
IBOutlet UIImageView * remoteView
This will be updated with video sent from the remote endpoint of the call.
Definition: CJGuestCall.h:360
BOOL audioInUnmuted
Convenience property for determining whether the audio input is unmuted.
Definition: CJGuestCall.h:587
BOOL videoControlEnabled
Convenience property for determining whether the video ouput control is disabled by policy from serve...
Definition: CJGuestCall.h:601
There was an error in the SIP configuration.
Definition: CJGuestCall.h:218
CGSize remotePresoSize
The size of the remotePreso video image.
Definition: CJGuestCall.h:375
void reject()
The delegate calls this to reject the invalid certificate.
void unmuteVideoOut()
Start the process of unmuting the video output.
Definition: CJGuestCall.mm:967
UIInterfaceOrientation captureOrientation
Indicates the orientation of the device so the video capture can compensate and send the video in the...
Definition: CJGuestCall.h:396