类 | |
interface | LogFilter |
Public 成员函数 | |
abstract int | enableAudioRecording (boolean enabled) |
abstract int | enableVideoCapturing (boolean enabled) |
abstract int | startStreaming (String publishUrl) |
abstract int | stopStreaming () |
abstract int | muteAudioStream (boolean muted) |
abstract int | muteVideoStream (boolean muted) |
abstract int | switchResolution (int width, int height) |
abstract int | snapshot (SnapshotCallback snapshotCallback) |
abstract int | switchCamera () |
abstract boolean | addVideoFilter (VideoFilter videoFilter) |
abstract boolean | removeVideoFilter (VideoFilter videoFilter) |
abstract int | adjustRecordingSignalVolume (int volume) |
abstract AgoraCameraCapturer | getCameraCapture () |
abstract VideoPreviewRenderer | getVideoPreviewRenderer () |
abstract int | registerAudioFrameObserver (AudioFrameObserver observer) |
abstract void | unregisterAudioFrameObserver (AudioFrameObserver observer) |
abstract int | registerVideoFrameObserver (VideoFrameObserver observer) |
abstract void | unregisterVideoFrameObserver (VideoFrameObserver observer) |
abstract int | setLogFile (String filePath) |
abstract int | setLogFilter (@LogFilter int filter) |
abstract int | setLogFileSize (int fileSizeInKBytes) |
abstract int | startScreenCapture (Intent intent, int width, int height) |
abstract void | stopScreenCapture () |
静态 Public 成员函数 | |
static synchronized StreamingKit | create (StreamingContext streamingContext) throws Exception |
static synchronized void | destroy () |
static String | getSdkVersion () |
StreamingKit
类。
该类是 Agora Streaming Kit 的主要类。请调用该类的方法实现 Agora Streaming Kit 提供的功能。
StreamingKit
类的方法,不要在不同的线程里调用。
|
static |
创建一个 StreamingKit 实例。
调用该方法创建一个 StreamingKit 实例,初始化 Agora Streaming Kit 服务。
streamingContext | Context,详见 StreamingContext。 |
Exception | StreamingKit 创建失败。 |
|
static |
销毁 StreamingKit 实例。
该方法释放 Agora Streaming Kit 使用的所有资源。调用该方法后,你将无法再使用 Kit 提供的其他 API。 如果你需要重新使用 Kit,你需要调用 create 方法,重新创建一个 StreamingKit 实例。
destroy
方法执行结束后再创建。
|
abstract |
开启或关闭音频采集。
enabled | 是否开启音频采集:
|
|
abstract |
开启或关闭视频采集。
enabled | 是否开启视频采集:
|
|
abstract |
开始向 CDN 推送媒体流。
调用该方法后,Agora Streaming Kit 会自动采集音视频,并将采集到音视频推送到指定的一个 CDN URL 地址上,以开始直播推流。
Kit 只支持同一时间向一个 CDN URL 地址推流。如果你再次调用该方法向第二个地址推流,Kit 会返回错误码 START_STREAMING_ERR_ALREADY_STARTED (3)
。
调用该方法开始推流后,如果你需要修改 CDN URL 地址,请先调用 stopStreaming 方法结束旧地址上的推流后, 再调用该方法并传入新的 CDN URL 地址。
channel profile
必须设为直播。publishUrl | CDN 推流 URL 地址。必须为有效的 RTMP 地址。字符长度不能超过 1024 字节。URL 不支持中文等特殊字符。 |
|
abstract |
停止向 CDN 推送媒体流。
调用 startStreaming 向指定的一个 CDN 推流 URL 地址开始推送媒体流后,调用 stopStreaming 方法可以停止推送该媒体流,结束直播推流。
|
abstract |
停止或恢复发送音频流。
muted | 是否停止发送音频流:
|
|
abstract |
停止或恢复发送视频流。
muted | 是否停止发送视频流:
|
|
abstract |
切换分辨率。
如果创建 Streaming Kit 时设置的视频分辨率无法满足你当前需求,你可以调用本方法切换分辨率。 该方法影响本地用户和远端用户所见。
width | 视频的宽度 (px)。 |
height | 视频的高度 (px)。 |
|
abstract |
对设备屏幕截图。
截图成功后,Streaming Kit 会触发 SnapshotCallback 回调并报告图像数据 SnapshotFrame。你需要自行处理该图像。
snapshotCallback | (输出参数)详见 SnapshotCallback 回调。 |
|
abstract |
切换前置和后置摄像头。
Streaming Kit 的初始状态为使用前置摄像头。
|
abstract |
添加 video filter。
调用该方法可以向 video track 添加一个 video filter,以进行视频前处理,如美颜。
videoFilter | video filter,详见 VideoFilter。 |
|
abstract |
移除 video filter。
调用 addVideoFilter 方法添加 video filter 后,你可以调用该方法移除 video filter。
videoFilter | video filter,详见 VideoFilter。 |
|
abstract |
调节音量。
Streaming Kit 会将采集到的音频输出并推送到 CDN URL 地址。调用该方法,你可以调节 Streaming Kit 的输出音量。
volume | 音量。取值范围可为 [0,400]。为避免回声并提升直播质量,Agora 建议取值 为 [0,100]。如果超出该范围,请先联系技术支持。
|
|
abstract |
获取管理摄像头采集行为的对象。
调用该方法,获取 AgoraCameraCapturer 对象,该对象提供管理摄像头采集行为的方法。
|
abstract |
获取视频预览渲染器对象。
调用该方法,获取 VideoPreviewRenderer 对象,该对象提供管理视频本地渲染的方法。
|
abstract |
|
abstract |
取消注册音频帧观测器对象。
observer | 音频帧观测器,详见 AudioFrameObserver。 |
|
abstract |
|
abstract |
取消注册视频帧观测器对象。
observer | 视频帧观测器,详见 VideoFrameObserver。 |
|
abstract |
设置日志文件路径。
Agora Streaming Kit 运行时产生的所有 log 都写入日志文件。日志文件会存储至默认路径,即 /sdcard/Android/data/{App 的包名}/files/streaming-kit.log
。如果你需要修改日志文件路径,请调用该方法设置日志文件路径。
filePath | 日志文件的完整路径。该日志文件为 UTF-8 编码。请确保该路径存在且可写。 |
|
abstract |
设置日志文件过滤等级。
设置 Agora Streaming Kit 输出日志的过滤等级。过滤等级从低到高分别为 OFF,DEBUG,INFO,WARN, ERROR,CRITICAL。指定一个过滤等级后,Kit 会输出该等级和高于该等级的所有日志信息。详见 filter
。
filter | 日志文件的过滤等级,详见 LogFilter。 |
|
abstract |
设置每个日志文件大小。
Agora Streaming Kit 会输出两个日志文件,每个文件大小都默认为 512 KB。如果你使用默认的文件大小,当输出的日志内容超过 1024 KB 时, 新输出的日志内容会覆盖旧的日志内容。如果你需要修改日志文件大小,请调用该方法设置每个日志文件的大小。
fileSizeInKBytes | 每个日志文件的大小(KB)。取值范围为 [128, 20480]。取值小于 128 KB 时,Agora 会自动调整为 128 KB。 |
|
static |
获取 Streaming Kit 的版本号。
"1.1.0"
。
|
abstract |
开启屏幕共享。
intent | Android 的 intent。 |
width | 共享屏幕的宽度 (px)。 |
height | 共享屏幕的高度 (px)。 |
|
abstract |
结束屏幕共享。