HyphenateSDK  3.3.0
Instance Methods | Properties | List of all members
EMCallSession Class Reference
Inheritance diagram for EMCallSession:

Instance Methods

(EMError *) - pauseVoice
 
(EMError *) - resumeVoice
 
(EMError *) - pauseVideo
 
(EMError *) - resumeVideo
 
(void) - switchCameraPosition:
 
(NSString *sessionId) - EM_DEPRECATED_IOS
 
(NSString *username) - EM_DEPRECATED_IOS
 
(NSString *remoteUsername) - EM_DEPRECATED_IOS
 
(int videoBitrate) - EM_DEPRECATED_IOS
 
(3_1_0, 3_1_5,"Delete") - EM_DEPRECATED_IOS
 
(3_1_0, 3_1_5,"Use -EMCallSession.videoLatency") - EM_DEPRECATED_IOS
 
(3_1_0, 3_1_5,"Use -EMCallSession.remoteVideoFrameRate") - EM_DEPRECATED_IOS
 
(3_1_0, 3_1_5,"Use -EMCallSession.remoteVideoLostRateInPercent") - EM_DEPRECATED_IOS
 
(3_1_0, 3_1_5,"Use -EMCallSession.remoteVideoResolution") - EM_DEPRECATED_IOS
 
(3_1_0, 3_1_5,"Use -EMCallSession.remoteVideoResolution") - EM_DEPRECATED_IOS
 
(3_1_0, 3_1_5,"Use -EMCallSession.remoteVideoBitrate") - EM_DEPRECATED_IOS
 
(3_1_0, 3_1_5,"Use -EMCallSession.localVideoBitrate") - EM_DEPRECATED_IOS
 
(void) - screenCaptureToFilePath:error:
 
(void) - startVideoRecordingToFilePath:error:
 
(NSString *) - stopVideoRecording:
 
("Use -getVideoLatency") - __deprecated_msg
 
("Use -getVideoFrameRate") - __deprecated_msg
 
("Use -getVideoLostRateInPercent") - __deprecated_msg
 
(void) - takeRemotePicture:
 
(BOOL) - startVideoRecord:
 
("Use -stopVideoRecording:") - __deprecated_msg
 
(void) - setCameraBackOrFront:
 

Properties

NSString * callId
 
NSString * localName
 
EMCallType type
 
BOOL isCaller
 
NSString * remoteName
 
EMCallSessionStatus status
 
EMCallLocalViewlocalVideoView
 
EMCallRemoteViewremoteVideoView
 
EMCallConnectType connectType
 
int videoLatency
 
int localVideoFrameRate
 
int remoteVideoFrameRate
 
int localVideoBitrate
 
int remoteVideoBitrate
 
int localVideoLostRateInPercent
 
int remoteVideoLostRateInPercent
 
CGSize remoteVideoResolution
 
NSString * ext
 

Method Documentation

- ("Use -getVideoLatency") __deprecated_msg

Get video delay time, in milliseconds, it's real time changed

Returns
The delay time
- ("Use -getVideoFrameRate") __deprecated_msg

Get video frame rate, it's real time changed

Returns
The frame rate
- ("Use -getVideoLostRateInPercent") __deprecated_msg

Get video package lost rate

Returns
Package lost rate

Stop recording video

Returns
path of record file
- (NSString* sessionId) EM_DEPRECATED_IOS (3_1_0) 
(3_1_5) 
("Use EMCallSession.callId")   

Unique session id

- (NSString* username) EM_DEPRECATED_IOS (3_1_0) 
(3_1_5) 
("Use EMCallSession.localName")   

Local username

- (NSString* remoteUsername) EM_DEPRECATED_IOS (3_1_0) 
(3_1_5) 
("Use EMCallSession.remoteName")   

The other side's username

- (3_1_0, 3_1_5, "Use -EMCallSession.videoLatency") EM_DEPRECATED_IOS

Get video latency, in milliseconds, changing in real time

Returns
The delay time
- (int videoBitrate) EM_DEPRECATED_IOS (3_1_0) 
(3_1_5) 
("Use EMCallOptions.videoKbps")   

Video bit rate, must be set before call session is started.

Value range is 150-1000, the default is 600.

- (3_1_0, 3_1_5, "Use -EMCallSession.remoteVideoBitrate") EM_DEPRECATED_IOS

Get the other party's bitrate, changing in real time

Returns
The other party's bitrate
- (3_1_0, 3_1_5, "Use -EMCallSession.localVideoBitrate") EM_DEPRECATED_IOS

Get bitrate of video call, changing in real time

Returns
Bitrate of video call
- (3_1_0, 3_1_5, "Delete") EM_DEPRECATED_IOS

Get voice volume of the call

Returns
Volume
- (3_1_0, 3_1_5, "Use -EMCallSession.remoteVideoLostRateInPercent") EM_DEPRECATED_IOS

Get video package lost rate

Returns
Video package lost rate
- (3_1_0, 3_1_5, "Use -EMCallSession.remoteVideoResolution") EM_DEPRECATED_IOS

Get fixed video original height

Returns
Video original height
- (3_1_0, 3_1_5, "Use -EMCallSession.remoteVideoFrameRate") EM_DEPRECATED_IOS

Get video frame rate, changing in real time

Returns
The video frame rate
- (3_1_0, 3_1_5, "Use -EMCallSession.remoteVideoResolution") EM_DEPRECATED_IOS

Get video original width

Returns
Video original width
- (EMError *) pauseVideo

Suspend video data transmission

Returns
Error
- (EMError *) pauseVoice

Mute the voice during call by suspending voice data transmission

Returns
Error
- (EMError *) resumeVideo

Resume video data transmission

Returns
Error
- (EMError *) resumeVoice

Unmute the voice during call by suspending voice data transmission

Returns
Error
- (void) screenCaptureToFilePath: (NSString *)  aPath
error: (3_1_0) 
(3_1_5) 
("Use -")  EM_DEPRECATED_IOS[EMPluginVideoRecorder screenCaptureToFilePath:error:] 

Get a snapshot of current video screen as jpeg picture and save to the local file system.

Parameters
aPathSaved path of picture
- (void) setCameraBackOrFront: ("Use -switchCameraPosition:")  __deprecated_msg

Use front camera or back camera,default use front

Parameters
isFontWeather use front camera or not,Yes is Front,No is Back
- (BOOL) startVideoRecord: ("Use startVideoRecordingToFilePath:error:")  __deprecated_msg

Start recording video

Parameters
aPathFile save path
- (void) startVideoRecordingToFilePath: (NSString *)  aPath
error: (3_1_0) 
(3_1_5) 
("Use -")  EM_DEPRECATED_IOS[EMPluginVideoRecorder startVideoRecordingToFilePath:error] 

Start recording video

Parameters
aPathFile saved path
aErrorError
- (NSString *) stopVideoRecording: (3_1_0) 
(3_1_5) 
("Use -")  EM_DEPRECATED_IOS[EMPluginVideoRecorder stopVideoRecording:] 

Stop recording video

Parameters
aErrorError
- (void) switchCameraPosition: (BOOL)  aIsFrontCamera

Use front camera or back camera. Default is front camera

Parameters
aIsFrontCameraYES for front camera, NO for back camera.
- (void) takeRemotePicture: ("Use -screenCaptureToFilePath:")  __deprecated_msg

Get snapshot of video

Parameters
aFullPathSave path of picture

Property Documentation

- (NSString*) callId
readnonatomicstrong

Unique call id. The call session ID is obtained after initiated a call startCall:remoteName:ext:completion:(void (^)(EMCallSession *aCallSession, EMError *aError))aCompletionBlock;

- (EMCallConnectType) connectType
readnonatomicassign

Connection type

- (NSString*) ext
readnonatomicassign

Call extention

Type must be NSString

- (BOOL) isCaller
readnonatomicassign

Whether it is the caller, the call initiator

- (NSString*) localName
readnonatomicstrong

Local username

- (int) localVideoBitrate
readnonatomicassign

Local bitrate, changing in real time return -1 if no data is available. Usually no data until few seconds of calling later.

- (int) localVideoFrameRate
readnonatomicassign

Local video frame rate, changing in real time return -1 if no data is available. Usually no data until few seconds of calling later.

- (int) localVideoLostRateInPercent
readnonatomicassign

Local video package lost rate, changing in real time return -1 if no data is available. Usually no data until few seconds of calling later.

- (EMCallLocalView*) localVideoView
readwritenonatomicstrong

Local display view

- (NSString*) remoteName
readnonatomicstrong

Remote party's username

- (int) remoteVideoBitrate
readnonatomicassign

Remote party bitrate, changing in real time return -1 if no data is available. Usually no data until few seconds of calling later.

- (int) remoteVideoFrameRate
readnonatomicassign

Remote party video frame rate, changing in real time return -1 if no data is available. Usually no data until few seconds of calling later.

- (int) remoteVideoLostRateInPercent
readnonatomicassign

Remote video package lost rate, changing in real time Didn't get to show -1

- (CGSize) remoteVideoResolution
readnonatomicassign

Remote video resolution return (-1, 1) if no data is available. Usually no data until few seconds of calling later.

- (EMCallRemoteView*) remoteVideoView
readwritenonatomicstrong

Remote display view

- (EMCallSessionStatus) status
readnonatomicassign

Call session status

- (EMCallType) type
readnonatomicassign

Call type

- (int) videoLatency
readnonatomicassign

Video latency, in milliseconds, changing in real time return -1 if no data is available. Usually no data until few seconds of calling later.


The documentation for this class was generated from the following file: