RevueSDK

Topics

Classes

• class AudioBufferCapturer

  Audio Buffer 擷取器 — 讓 App 注入任意 PCM 音訊

• class AudioCompositor

  音訊混音器 — 將多路 AudioTrack 混音為一路輸出（獨立工具）

• class AudioManager

  音訊管理器 — 裝置管理、說話偵測、音量監控

• class AudioTrack

  音訊 Track 中間類別 — 統一管理 AudioRenderer 分發

• class BroadcastManager

  Manages the broadcast state and track publication for screen sharing on iOS.

• class BufferCapturer

  Buffer 擷取器 — 讓 App 注入任意 CVPixelBuffer 作為視訊來源

• class CameraCaptureOptions

  相機擷取選項

• class CameraCapturer

  相機擷取器 — 控制相機硬體

• class FriendManager

  好友管理器

• class LocalAudioTrack

  本地音訊 Track — 麥克風或自訂音訊輸入

• class LocalParticipant

  本地參與者（自己）— 發佈 Track、控制相機/麥克風/螢幕分享

• class LocalTrackPublication

  本地 Track 發佈狀態

• class LocalVideoTrack

  本地視訊 Track — 相機、螢幕分享、或外部影像輸入

• class MicrophoneCapturer

  麥克風擷取器 — 對外介面（薄殼，conform AudioCapturer protocol）

• class MulticastDelegate

  多播代理容器 — 支援多個物件同時監聽事件

• class Participant

  參與者基礎類別 — LocalParticipant 和 RemoteParticipant 的共用屬性

• class PresenceManager

  Presence 管理器

• class RemoteAudioTrack

  遠端音訊 Track — 其他參與者的麥克風聲音

• class RemoteParticipant

  遠端參與者（其他人）— 可訂閱其 Track、控制連線狀態

• class RemoteTrackPublication

  遠端 Track 發佈狀態

• class RemoteVideoTrack

  遠端視訊 Track — 其他參與者的相機或螢幕分享畫面

• class Revue

  朋友層 singleton — SDK 入口點，管理好友關係、事件輪詢、delegate 推送

• class RevueSampleHandler

  Extension 端 base class — 開發者繼承後只需 override enableLogging（可選）

• class Room

  會議室 — 管理參與者、Track 發佈/訂閱的核心物件（singleton）

• class ScreenShareCaptureOptions

  螢幕分享擷取選項

• class SecurityManager

  安全管理器

• class Track

  Track 基礎類別 — 一路獨立的媒體串流

• class TrackPublication

  Track 發佈狀態 — 包裝 Track 的發佈/訂閱資訊

• class TrackRecorder

  Track 錄影器 — 將單一 VideoTrack + 單一 AudioTrack 錄製為 fMP4 檔案

• class VideoCapturer

  視訊擷取器基底類別

• class VideoCompositor

  視訊合成器 — 將多路 VideoTrack 按模板合成為一路輸出（獨立工具）

• class VideoTrack

  視訊 Track 中間類別 — 統一管理 VideoRenderer 分發

• class VideoView

  視訊顯示元件 — UIView 容器，支援 Metal / SampleBuffer 雙模式渲染

Protocols

• protocol AudioCapturer

  音訊擷取器基礎協定

• protocol AudioRenderer

  音訊渲染器協定 — 接收 Float32 PCM 音訊

• protocol BroadcastManagerDelegate

  A delegate protocol for receiving updates about the broadcast state.

• protocol ParticipantDelegate

  參與者事件代理 — 細粒度訂閱單一 Participant 的事件

• protocol RevueDelegate

  朋友層事件代理 — 監聽好友連線、訊息、Presence 等事件

• protocol RoomDelegate

  房間事件代理 — 監聽連線、通話、參與者、Track 等事件

• protocol TrackDelegate

  軌道事件代理 — 訂閱單一 Track 本身的事件

• protocol VideoCapturerDelegate

  擷取器事件代理 — 訂閱解析度／狀態變更

• protocol VideoProcessor

  視訊處理器協定 — 可選的視訊處理管線

• protocol VideoRenderer

  視訊渲染器協定 — VideoView 實作此協定接收畫面

• protocol VideoViewDelegate

  視訊顯示元件事件代理 — 訂閱單一 VideoView 的渲染狀態變化

Structures

• struct AudioDevice

  音訊裝置資訊

• struct AudioEncoding

  音訊編碼設定

• struct AudioPublishOptions

  音訊發佈選項 — 設定音訊 Track 的編碼參數

• struct CodecStatistics

  當前視訊編碼統計。

• struct CompositeTemplate

  合成模板 — 定義多路 VideoTrack 的排版方式

• struct FriendConnectionPaths

  好友連線路徑（封裝 C 層 RevueKitFriendPathBitmap）

• struct H264Encoding

  H.264 編碼參數

• struct IceCandidatePairStatistics
• struct InboundStatistics

  收端統計（視訊 + 音訊）。

• struct OutboundStatistics

  發端送出統計。

• struct RecordingFileInfo

  錄影檔案資訊

• struct RevueLogEntry

  SDK log 條目（C 核心層 log 透過 callback 進來、Swift 端組成此型別推給訂閱者）

• struct TrackStatistics

  只保留「有料且對診斷有用」的桶（收斂記錄見 spec）：

• struct VideoPublishOptions

  視訊發佈選項 — 設定視訊 Track 的編碼參數

• struct VideoSourceStatistics

  發送側來源畫面統計（編碼前）。

• struct VideoTrackPositionInfo

  單一 Track 的位置資訊

• struct Vp8Encoding

  VP8 編碼參數

Type Aliases

• typealias FrameDecryptCallback

  解密單幀 callback。回 0=成功；非 0=失敗（drop 該幀 + 發 FrameCryptoError 事件）。

• typealias FrameEncryptCallback

  加密單幀 callback。回 0=成功；非 0=失敗（drop 該幀 + 發 FrameCryptoError 事件）。

• typealias FrameGetMaxSizeCallback

  查詢密文上限 callback。對相同 (mediaType, plaintextSize, userData state) 須 deterministic， 回傳值必須 ≥ encrypt 實際寫出的大小（XOR/AES-CTR 回 plaintextSize；AES-GCM 回 plaintextSize+16）。

Enumerations

• enum AudioDuckingLevel
• enum CameraCapturerError

  相機擷取器的錯誤

• enum CaptureState

  擷取器狀態

• enum ConnectionQuality

  參與者的連線品質（5 級）

• enum DegradationPreference

  品質降級偏好 — 頻寬不足時優先降什麼

• enum DisconnectReason

  通話中對方斷線原因

• enum DiskSpaceWarning

  磁碟空間警告事件

• enum FrameCryptoError

  Frame crypto 加解密逐幀錯誤（v0.14.0，C 層 REVUEKIT_EVENT_FRAME_CRYPTO_ERROR type 102）。

• enum FrameMediaType

  Frame 媒體型別

• enum FriendAddError

  加好友錯誤

• enum FriendCallError

  撥號 / 接聽 / 拒接 / 取消邀請的錯誤（FriendManager 撥號四方法 throw）

• enum FriendDeleteError

  刪除好友錯誤

• enum FriendMessageError

  發送訊息錯誤

• enum InvitationEndReason

  邀請結束原因

• enum PresenceConnectionState

  自身 Presence 服務（MQTT broker）連線狀態

• enum PresenceStatus

  好友 Presence 狀態（對應 C 層 RevueKitPresenceStatus）

• enum RcMode

  VP8 Rate Control 模式

• enum RecorderState

  錄影器狀態

• enum RecordingError
• enum RevueInitError

  SDK 初始化錯誤（Revue.initialize throw）

• enum RevueLogLevel

  log 級別（對應 C 層 RevueKitLogLevel，rawValue 直接對齊 Int32 ABI）

• enum RevuePresenceError

  Why Revue.startPresence(_:) failed.

• enum RoomError

  SDK 錯誤類型

• enum RoomMessageError

  Room 層訊息錯誤型別

• enum ScreenShareError

  螢幕分享錯誤型別

• enum SelfConnectionStatus

  自身與 DHT 網路的連線狀態（對應 C 層 RevueKitConnectionStatus）

• enum UserStatus

  使用者狀態（對應 C 層 RevueKitUserStatus）

• enum VideoCodec

  視訊編碼器（含對應 encoding 參數）

• enum VideoCodecType

  視訊編碼器類型（不帶 encoding 的 lightweight tag）

• enum VideoContentMode

  單一 Track 的內容縮放模式

• enum VideoRotation