README.zh.md 12 KB
API-Example-Unity
Read this in other languages: English
简介
这个开源示例项目演示了不同场景下，Agora SDK 的基本集成逻辑。 项目中每个 Scene 都是一个独立的场景，都可以成功独立运行。
在这个示例项目中包含的所有场景都可以独立运行：
项目结构
- 基础案例:
| Demo | Description | APIs |
|---|---|---|
| JoinChannelAudio | 基础音频通话 | CreateAgoraRtcEngine, JoinChannelByKey, LeaveChannel |
| JoinChannelVideo | 基础视频通话 | SetChannelProfile,SetClientRole,EnableVideo,EnableVideo, JoinChannelByKey, VideoSurface |
- 进阶案例:
| Demo | Description | APIs |
|---|---|---|
| AudioMixing | 在频道内播放混音和已音效 | StartAudioMixing, PlayEffect |
| AudioSpectrum | 媒体音谱功能 | IAudioSpectrumObserver, RegisterMediaPlayerAudioSpectrumObserver |
| ChannelMediaRelay | 启动跨通道媒体流转发。该方法可用于实现跨通道连麦等场景。 | StartChannelMediaRelay, UpdateChannelMediaRelay, PauseAllChannelMediaRelay, ResumeAllChannelMediaRelay, StopChannelMediaRelay |
| ContentInspect | 内容鉴定 | SetContentInspect |
| CustomCaptureAudio | 推送外部音频帧 | PushAudioFrame |
| CustomCaptureVideo | 推送外部视频帧 | PushVideoFrame |
| CustomRenderAudio | 拉取远端音频数据 | PullAudioFrame |
| DeviceManager | 获取当前的音视频设备信息 | GetAudioDeviceManager, GetVideoDeviceManager |
| DualCamera | 双摄像头工作 | StartPrimaryCameraCapture, StartSecondaryCameraCapture |
| JoinChannelVideoToken | 使用Token加入频道和更新Token | RenewToken |
| JoinChannelWithUserAccount | 使用用户账号加入频道 | JoinChannelWithUserAccount, GetUserInfoByUserAccount |
| MediaPlayer | 播放媒体文件 | CreateMediaPlayer, Play, Stop |
| MediaRecorder | 媒体录制 | StartRecording, StopRecording, |
| Metadata | 发送元数据 | IMetadataObserver |
| ProcessAudioRawData | 获注册音频裸数据观测器,并用audioclip播放获取到的音频数据 | RegisterAudioFrameObserver, OnPlaybackAudioFrame, OnRceordAudioFrame |
| ProcessVideoRawData | 注册视频裸数据观测器,并渲染在Texture上 | RegisterVideoFrameObserver, OnCaptureVideoFrame, OnRenderVideoFrame |
| PushEncodedVideoImage | 发送结构化数据 | PushEncodedVideoImage |
| ScreenShare | 屏幕共享 | StartScreenCaptureByWindowId, StartScreenCaptureByDisplayId |
| ScreenShareWhileVideoCall | 在视频通话时进行屏幕共享 | StartScreenCaptureByWindowId, StartScreenCaptureByDisplayId |
| SetBeautyEffectOptions | 开启美颜效果 | SetBeautyEffectOptions |
| SetEncryption | 开启或关闭内置加密 | EnableEncryption |
| SetVideoEncoderConfiguration | 设置视频编码属性。 | SetVideoEncoderConfiguration |
| SpatialAudioWithMediaPlayer | 使用空间音效播放媒体文件 | GetLocalSpatialAudioEngine, UpdateRemotePositionEx |
| StartDirectCdnStreaming | cdn推流 | StartDirectCdnStreaming, SetDirectCdnStreamingVideoConfiguration, StopDirectCdnStreaming |
| StartLocalVideoTranscoder | 多路视频合成一路，可以合成png,jpg,jif等等 | StartLocalVideoTranscoder |
| StartRhythmPlayer | 开启节拍器 | StartRhythmPlayer |
| StartRtmpStreamWithTranscoding | 推流到CDN | StartRtmpStreamWithTranscoding, UpdateRtmpTranscoding, StopRtmpStream |
| StreamMessage | 发送流数据 | CreateDataStream, SendStreamMessage |
| TakeSnapshot | 屏幕截图 | TakeSnapshot |
| VirtualBackground | 开启虚拟背景 | EnableVirtualBackground |
| VoiceChanger | 变声设置 | SetVoiceBeautifierPreset, SetAudioEffectPreset,SetVoiceConversionPreset,SetLocalVoicePitch, SetLocalVoiceEqualization, SetLocalVoiceReverb |
如何运行示例程序
运行环境
- Unity 2017 LTS 或以上
运行步骤
首先在 Agora.io 注册 注册账号，并创建自己的测试项目，获取到 AppID。
然后在 Agora.io SDK 下载 Unity SDK，解压后把 sdk 包中的 unitypackage文件导入工程
最后使用 Unity 打开本项目, 将获取到的AppID填入***API-Example-Unity/Assets/API-Example/appIdInput/AppIdInput.asset**中
一切就绪。你可以自由探索示例项目，体验 SDK 的丰富功能。
反馈
如果您对示例项目有任何问题或建议，请随时提交问题。
参考文档
- 您可以在 文档中心找到完整的API文档
- 您可以在 发版说明找到完整的发版说明
- 您可以在 github issue提交你的issue
相关资源
- 你可以先参阅常见问题
- 如果你想了解更多官方示例，可以参考官方 SDK 示例
- 如果你想了解声网 SDK 在复杂场景下的应用，可以参考官方场景案例
- 如果你想了解声网的一些社区开发者维护的项目，可以查看社区
- 如果你想了解声网的跨平台框架和云市场相关的项目，可以查看AgoraIO-Extensions
- 若遇到问题需要开发者帮助，你可以到开发者社区提问
- 如果需要售后技术支持, 你可以在Agora Dashboard提交工单
代码许可
示例项目遵守 MIT 许可证。