FYRtcEngine:
public static FYRtcEngine create(Context context, String appId, String appToken, FYRtcEventHandler handler);
参数 |
是否必须 |
描述 |
context |
是 |
应用程序上下文 |
appId |
是 |
应用id |
appToken |
是 |
应用token |
handler |
是 |
一个提供了缺省实现的抽象类,SDK通过该抽象类向报告SDK运行时的各种事件 |
public static String getVersion();
public void joinChannel(String channelId, String uid, FYOptionData option);
参数 |
是否必须 |
描述 |
channelId |
是 |
频道id,字符串,数字,_,长度不超过40位 |
uid |
否 |
用户id,为空时sdk会生成一个uuid作为uid |
option |
否 |
选项,可以配置最大时长,是否录音和透传数据 |
public void leaveChannel();
public void muteRemoteAudio(String uid, boolean enabled);
参数 |
是否必须 |
描述 |
uid |
是 |
被静音的成员uid |
enabled |
是 |
true:静音,false:解除静音 |
public void muteOtherRemoteAudio(String uid, boolean enabled);
参数 |
是否必须 |
描述 |
uid |
是 |
不被静音的成员uid |
enabled |
是 |
true:静音,false:解除静音 |
public void muteAllRemoteAudio(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:静音,false:解除静音 |
public void muteLocalAudio(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:静音,false:解除静音 |
public void dialPeer(String calleeUid, String callerUid, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeUid |
是 |
被叫用户id |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
public void dialPstn(String calleeNumber, String callerUid, String display, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeNumber |
是 |
被叫号码,E164格式,如:133xxxx6611 |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
display |
否 |
显号,为空时,显示随机号码 |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
public void dialBack(String calleeNumber, String calleeDisplay,
String callerNumber, String callerDisplay,
String callerUid, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeNumber |
是 |
被叫号码,E164格式,如:+86133xxxx6611 |
calleeDisplay |
否 |
被叫显示号码,E164格式,为空时显示随机号码 |
callerNumber |
是 |
主叫号码,E164格式,为空时显示随机号码 |
callerDisplay |
否 |
主叫显示号码,E164格式,为空时显示随机号码 |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
主叫呼叫被叫时,可以使用离线推送(如小米push)通知被叫,被叫调用calleePrepare
准备接听来电,调用成功后一段时间内都可以接听到点对点语音来电。
public void calleePrepare(String callerUid);
参数 |
是否必须 |
描述 |
callerUid |
是 |
当前的uid |
public void endCall();
public void answerCall();
public void setEnableSpeaker(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:切换到扬声器,false:切换到听筒 |
public void sendDtmf(char dtmf);
参数 |
是否必须 |
描述 |
dtmf |
是 |
dtmf: 0-9,*,# |
public void setRing(Uri ringtone);
参数 |
是否必须 |
描述 |
ringtone |
是 |
铃声,null代表静音 |
public String getRing();
返回值 |
描述 |
String |
当前来电的铃声,null代表静音 |
public void setVibratorEnabled(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:震动,false:不震动 |
public boolean isVibratorEnabled();
public void setLogFile(String filePath);
参数 |
是否必须 |
描述 |
filePath |
是 |
日志文件的路径 |
public void setLogFilter(int level);
参数 |
是否必须 |
描述 |
level |
是 |
日志文件的级别,如:android.util.Log.INFO |
FYOptionData
通话需要的选项,可以为空。
public class FYOptionData {
int maxDuration;
boolean isRecord;
String data;
}
FYRtcEventHandler
public void onError(FYError error);
public void onJoinChannelSuccess(String channelId, String uid);
public void onLeaveChannel(RtcStats stats);
public void onUserJoined(String uid);
public void onUserOffline(String uid);
public void onUserMuteAudio(String uid, boolean muted);
public void onRtcStats(RtcStats stats);
public void onIncomingCall(String caller);
public void onOutgoingCall(String callee, String uid);
public void onCallConnect(String uid);
public void onCallEnd(RtcStats stats);
public void onDialBackSuccess();
public void onDtmfReceived(char dtmf);
- FYRtcEventHandler.RtcStats:
public static class RtcStats {
public float downBandWidth;
public float upBandWidth;
public float sendLossRate;
public float recvLossRate;
public long sendBytes;
public long recvBytes;
}
### FYRtcEngine:
public static FYRtcEngine create(Context context, String appId, String appToken, FYRtcEventHandler handler);
参数 |
是否必须 |
描述 |
context |
是 |
应用程序上下文 |
appId |
是 |
应用id |
appToken |
是 |
应用token |
handler |
是 |
一个提供了缺省实现的抽象类,SDK通过该抽象类向报告SDK运行时的各种事件 |
public static String getVersion();
public void joinChannel(String channelId, String uid, FYOptionData option);
参数 |
是否必须 |
描述 |
channelId |
是 |
频道id,字符串,数字,_,长度不超过40位 |
uid |
否 |
用户id,为空时sdk会生成一个uuid作为uid |
option |
否 |
选项,可以配置最大时长,是否录音和透传数据 |
public void leaveChannel();
public void muteRemoteAudio(String uid, boolean enabled);
参数 |
是否必须 |
描述 |
uid |
是 |
被静音的成员uid |
enabled |
是 |
true:静音,false:解除静音 |
public void muteOtherRemoteAudio(String uid, boolean enabled);
参数 |
是否必须 |
描述 |
uid |
是 |
不被静音的成员uid |
enabled |
是 |
true:静音,false:解除静音 |
public void muteAllRemoteAudio(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:静音,false:解除静音 |
public void muteLocalAudio(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:静音,false:解除静音 |
public void dialPeer(String calleeUid, String callerUid, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeUid |
是 |
被叫用户id |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
public void dialPstn(String calleeNumber, String callerUid, String display, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeNumber |
是 |
被叫号码,E164格式,如:133xxxx6611 |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
display |
否 |
显号,为空时,显示随机号码 |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
public void dialBack(String calleeNumber, String calleeDisplay,
String callerNumber, String callerDisplay,
String callerUid, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeNumber |
是 |
被叫号码,E164格式,如:+86133xxxx6611 |
calleeDisplay |
否 |
被叫显示号码,E164格式,为空时显示随机号码 |
callerNumber |
是 |
主叫号码,E164格式,为空时显示随机号码 |
callerDisplay |
否 |
主叫显示号码,E164格式,为空时显示随机号码 |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
主叫呼叫被叫时,可以使用离线推送(如小米push)通知被叫,被叫调用calleePrepare
准备接听来电,调用成功后一段时间内都可以接听到点对点语音来电。
public void calleePrepare(String callerUid);
参数 |
是否必须 |
描述 |
callerUid |
是 |
当前的uid |
public void endCall();
public void answerCall();
public void setEnableSpeaker(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:切换到扬声器,false:切换到听筒 |
public void sendDtmf(char dtmf);
参数 |
是否必须 |
描述 |
dtmf |
是 |
dtmf: 0-9,*,# |
public void setRing(Uri ringtone);
参数 |
是否必须 |
描述 |
ringtone |
是 |
铃声,null代表静音 |
public String getRing();
返回值 |
描述 |
String |
当前来电的铃声,null代表静音 |
public void setVibratorEnabled(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:震动,false:不震动 |
public boolean isVibratorEnabled();
public void setLogFile(String filePath);
参数 |
是否必须 |
描述 |
filePath |
是 |
日志文件的路径 |
public void setLogFilter(int level);
参数 |
是否必须 |
描述 |
level |
是 |
日志文件的级别,如:android.util.Log.INFO |
FYOptionData
通话需要的选项,可以为空。
public class FYOptionData {
int maxDuration;
boolean isRecord;
String data;
}
FYRtcEventHandler
public void onError(FYError error);
public void onJoinChannelSuccess(String channelId, String uid);
public void onLeaveChannel(RtcStats stats);
public void onUserJoined(String uid);
public void onUserOffline(String uid);
public void onUserMuteAudio(String uid, boolean muted);
public void onRtcStats(RtcStats stats);
public void onIncomingCall(String caller);
public void onOutgoingCall(String callee, String uid);
public void onCallConnect(String uid);
public void onCallEnd(RtcStats stats);
public void onDialBackSuccess();
public void onDtmfReceived(char dtmf);
- FYRtcEventHandler.RtcStats:
public static class RtcStats {
public float downBandWidth;
public float upBandWidth;
public float sendLossRate;
public float recvLossRate;
public long sendBytes;
public long recvBytes;
}
### FYRtcEngine:
public static FYRtcEngine create(Context context, String appId, String appToken, FYRtcEventHandler handler);
参数 |
是否必须 |
描述 |
context |
是 |
应用程序上下文 |
appId |
是 |
应用id |
appToken |
是 |
应用token |
handler |
是 |
一个提供了缺省实现的抽象类,SDK通过该抽象类向报告SDK运行时的各种事件 |
public static String getVersion();
public void joinChannel(String channelId, String uid, FYOptionData option);
参数 |
是否必须 |
描述 |
channelId |
是 |
频道id,字符串,数字,_,长度不超过40位 |
uid |
否 |
用户id,为空时sdk会生成一个uuid作为uid |
option |
否 |
选项,可以配置最大时长,是否录音和透传数据 |
public void leaveChannel();
public void muteRemoteAudio(String uid, boolean enabled);
参数 |
是否必须 |
描述 |
uid |
是 |
被静音的成员uid |
enabled |
是 |
true:静音,false:解除静音 |
public void muteOtherRemoteAudio(String uid, boolean enabled);
参数 |
是否必须 |
描述 |
uid |
是 |
不被静音的成员uid |
enabled |
是 |
true:静音,false:解除静音 |
public void muteAllRemoteAudio(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:静音,false:解除静音 |
public void muteLocalAudio(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:静音,false:解除静音 |
public void dialPeer(String calleeUid, String callerUid, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeUid |
是 |
被叫用户id |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
public void dialPstn(String calleeNumber, String callerUid, String display, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeNumber |
是 |
被叫号码,E164格式,如:133xxxx6611 |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
display |
否 |
显号,为空时,显示随机号码 |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
public void dialBack(String calleeNumber, String calleeDisplay,
String callerNumber, String callerDisplay,
String callerUid, FYOptionData option);
参数 |
是否必须 |
描述 |
calleeNumber |
是 |
被叫号码,E164格式,如:+86133xxxx6611 |
calleeDisplay |
否 |
被叫显示号码,E164格式,为空时显示随机号码 |
callerNumber |
是 |
主叫号码,E164格式,为空时显示随机号码 |
callerDisplay |
否 |
主叫显示号码,E164格式,为空时显示随机号码 |
callerUid |
否 |
主叫用户id,为空时sdk会生成一个uid |
option |
否 |
呼叫选项,可配置最大时长,是否录音,透传数据 |
主叫呼叫被叫时,可以使用离线推送(如小米push)通知被叫,被叫调用calleePrepare
准备接听来电,调用成功后一段时间内都可以接听到点对点语音来电。
public void calleePrepare(String callerUid);
参数 |
是否必须 |
描述 |
callerUid |
是 |
当前的uid |
public void endCall();
public void answerCall();
public void setEnableSpeaker(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:切换到扬声器,false:切换到听筒 |
public void sendDtmf(char dtmf);
参数 |
是否必须 |
描述 |
dtmf |
是 |
dtmf: 0-9,*,# |
public void setRing(Uri ringtone);
参数 |
是否必须 |
描述 |
ringtone |
是 |
铃声,null代表静音 |
public String getRing();
返回值 |
描述 |
String |
当前来电的铃声,null代表静音 |
public void setVibratorEnabled(boolean enabled);
参数 |
是否必须 |
描述 |
enabled |
是 |
true:震动,false:不震动 |
public boolean isVibratorEnabled();
public void setLogFile(String filePath);
参数 |
是否必须 |
描述 |
filePath |
是 |
日志文件的路径 |
public void setLogFilter(int level);
参数 |
是否必须 |
描述 |
level |
是 |
日志文件的级别,如:android.util.Log.INFO |
FYOptionData
通话需要的选项,可以为空。
public class FYOptionData {
int maxDuration;
boolean isRecord;
String data;
}
FYRtcEventHandler
public void onError(FYError error);
public void onJoinChannelSuccess(String channelId, String uid);
public void onLeaveChannel(RtcStats stats);
public void onUserJoined(String uid);
public void onUserOffline(String uid);
public void onUserMuteAudio(String uid, boolean muted);
public void onRtcStats(RtcStats stats);
public void onIncomingCall(String caller);
public void onOutgoingCall(String callee, String uid);
public void onCallConnect(String uid);
public void onCallEnd(RtcStats stats);
public void onDialBackSuccess();
public void onDtmfReceived(char dtmf);
- FYRtcEventHandler.RtcStats:
public static class RtcStats {
public float downBandWidth;
public float upBandWidth;
public float sendLossRate;
public float recvLossRate;
public long sendBytes;
public long recvBytes;
}