ACSCall 類別

發行項
02/21/2024

宣告

@interface ACSCall : NSObject;

Description

描述通話

方法

addParticipant

使用 MRI 將參與者新增至通話。

-(ACSRemoteParticipant* _Nullable)addParticipant:(id<CommunicationIdentifier> _Nonnull)participant withError:(NSError*_Nullable*_Nonnull) error __attribute__((swift_error(nonnull_error)));

使用電話號碼新增參與通話。

-(ACSRemoteParticipant* _Nullable)addParticipant:(PhoneNumberIdentifier* _Nonnull) participant options:(ACSAddPhoneNumberOptions* _Nullable)options withError:(NSError*_Nullable*_Nonnull) error __attribute__((swift_error(nonnull_error)));

功能

呼叫的功能延伸模組。

-(id _Nonnull)feature: (Class _Nonnull)featureClass;

startAudio

啟動音訊串流

-(void)startAudio:(ACSCallAudioStream *)stream withCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

stream -
completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

stopAudio

停止音訊串流

-(void)stopAudio:(ACSCallAudioStream *)stream withCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

stream -
completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

靜音

將本機麥克風靜音。

-(void)muteWithCompletionHandler:(void (^)(NSError *error))completionHandler DEPRECATED_MSG_ATTRIBUTE("Use muteOutgoingAudio instead");

參數

completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

unmute

取消靜音本機麥克風。

-(void)unmuteWithCompletionHandler:(void (^)(NSError *error))completionHandler DEPRECATED_MSG_ATTRIBUTE("Use unmuteOutgoingAudio instead");

參數

completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

muteIncomingAudio

靜音喇叭。

-(void)muteIncomingAudioWithCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

unmuteIncomingAudio

取消靜音說話者。

-(void)unmuteIncomingAudioWithCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

unmuteOutgoingAudio

取消靜音麥克風。

-(void)unmuteOutgoingAudioWithCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

muteOutgoingAudio

將麥克風靜音。

-(void)muteOutgoingAudioWithCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

sendDtmf

傳送 DTMF 音調

-(void)sendDtmf:(ACSDtmfTone)tone withCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

tone -
completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

startVideo

開始將視訊串流分享至通話

-(void)startVideo:(ACSOutgoingVideoStream *)stream withCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

stream - 要共用的本機視訊串流
completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

stopVideo

停止將視訊串流共用至通話

-(void)stopVideo:(ACSOutgoingVideoStream *)stream withCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

stream - 要停止共用的本機視訊串流
completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

hangUp

通話停止回應

-(void)hangUp:(ACSHangUpOptions *)options withCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

options - 通話停止響應的選項
completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

removeParticipant

從通話中移除參與者

-(void)removeParticipant:(ACSRemoteParticipant *)participant withCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

participant -
completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

hold

保留此呼叫

-(void)holdWithCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

resume

繼續此呼叫

-(void)resumeWithCompletionHandler:(void (^)(NSError *error))completionHandler;

參數

completionHandler - 作業完成之後，要以異步方式叫用的區塊。

傳回

void

屬性

Delegate - 委派

您提供從這個 ACSCall 實例接收事件的物件。

@property(nonatomic, assign) id<ACSCallDelegate> delegate;

remoteParticipants

取得目前通話中的遠程參與者清單。如果與參與者有數百個以上的通話，只有媒體作用中的參與者會出現在此集合中。

@property (copy, nonnull, readonly) NSArray<ACSRemoteParticipant *> * remoteParticipants;

id

呼叫的標識碼

@property (retain, nonnull, readonly) NSString * id;

狀態

呼叫的目前狀態

@property (readonly) ACSCallState state;

callEndReason

包含指出呼叫結束方式的程式代碼/子碼

@property (retain, nonnull, readonly) ACSCallEndReason * callEndReason;

direction

傳出或傳入視通話方向而定

@property (readonly) ACSCallDirection direction;

isMuted

本機麥克風是否為靜音。

@property (readonly) BOOL isMuted DEPRECATED_MSG_ATTRIBUTE("Use isOutgoingAudioMuted instead");

isOutgoingAudioMuted

本機麥克風是否為靜音。

@property (readonly) BOOL isOutgoingAudioMuted;

isIncomingAudioMuted

本機喇叭是否為靜音。

@property (readonly) BOOL isIncomingAudioMuted;

callerInfo

呼叫端的身分識別

@property (retain, nonnull, readonly) ACSCallerInfo * callerInfo;

callLobby

取得 Teams 會議大廳。

@property (retain, nonnull, readonly) ACSCallLobby * callLobby;

activeIncomingAudioStream

通話中目前作用中的內送音訊串流

@property (retain, nonnull, readonly) ACSIncomingAudioStream * activeIncomingAudioStream;

activeOutgoingAudioStream

通話中目前作用中的傳出音訊串流

@property (retain, nonnull, readonly) ACSOutgoingAudioStream * activeOutgoingAudioStream;

callParticipantRole

通話中的參與者角色

@property (readonly) ACSCallParticipantRole callParticipantRole;

localVideoStreams

取得目前通話中的本機視訊串流清單。

@property (copy, nonnull, readonly) NSArray<ACSLocalVideoStream *> * localVideoStreams DEPRECATED_MSG_ATTRIBUTE("Use outgoingVideoStreams instead");

outgoingVideoStreams

取得目前呼叫中的傳出數據流清單。

@property (copy, nonnull, readonly) NSArray<ACSOutgoingVideoStream *> * outgoingVideoStreams;

totalParticipantCount

目前通話中作用中的參與者總數

@property (readonly) int totalParticipantCount;

liveOutgoingAudioFilters

取得目前的可設定傳出音訊篩選器

@property (retain, nonnull, readonly) ACSLiveOutgoingAudioFilters * liveOutgoingAudioFilters;

共用方式為