shengwang-electron-sdk 4.6.2-rc.1

package/types/Private/IAgoraMediaPlayerSource.d.ts

@@ -0,0 +1,109 @@
+import './extension/IAgoraMediaPlayerSourceExtension';
+import { CacheStatistics, MediaPlayerEvent, MediaPlayerReason, MediaPlayerState, PlayerPlaybackStats, PlayerPreloadEvent, PlayerUpdatedInfo, SrcInfo } from './AgoraMediaPlayerTypes';
+/**
+ * 提供媒体播放器的回调。
+ */
+export interface IMediaPlayerSourceObserver {
+    /**
+     * 报告播放器状态改变。
+     *
+     * 当播放器状态改变时，SDK 会触发该回调，报告新的播放状态。
+     *
+     * @param state 新的播放状态，详见 MediaPlayerState 。
+     * @param reason 播放器状态改变的原因，详见 MediaPlayerReason 。
+     */
+    onPlayerSourceStateChanged?(state: MediaPlayerState, reason: MediaPlayerReason): void;
+    /**
+     * 报告当前媒体资源的播放进度。
+     *
+     * 播放媒体文件时，SDK 每隔 1 秒会自动触发该回调，报告当前播放进度。
+     *
+     * @param positionMs 当前播放进度，单位为 ms。
+     * @param timestampMs 当前播放进度的 NTP 时间戳，单位为 ms。
+     */
+    onPositionChanged?(positionMs: number, timestampMs: number): void;
+    /**
+     * 报告播放器的事件。
+     *
+     * 调用 seek 定位播放后，SDK 会触发该回调，报告定位播放的结果。
+     *
+     * @param eventCode 播放器事件，详见 MediaPlayerEvent 。
+     * @param elapsedTime 发生事件的时间 (毫秒)。
+     * @param message 事件的信息。
+     */
+    onPlayerEvent?(eventCode: MediaPlayerEvent, elapsedTime: number, message: string): void;
+    /**
+     * 报告已获取媒体附属信息。
+     *
+     * 解析媒体附属信息后时，SDK 会触发该回调，报告媒体附属信息的数据类型和具体数据。
+     *
+     * @param data 具体数据，用户自定义格式的数据。
+     * @param length 数据长度，单位为 byte。
+     */
+    onMetaData?(data: Uint8Array, length: number): void;
+    /**
+     * 报告当前缓冲数据能播放的时间。
+     *
+     * 播放在线媒体资源的过程中，SDK 会每隔 1 秒触发一次该回调，报告当前缓冲的数据能支持的播放时间。
+     *  当缓冲数据支持的播放时间小于阈值（默认为 0）时，返回 PlayerEventBufferLow (6)。
+     *  当缓冲数据支持的播放时间大于阈值（默认为 0）时，返回 PlayerEventBufferRecover (7)。
+     *
+     * @param playCachedBuffer 当前缓冲的数据能支持的播放时间 (毫秒)。
+     */
+    onPlayBufferUpdated?(playCachedBuffer: number): void;
+    /**
+     * 报告预加载媒体资源的事件。
+     *
+     * @param src 媒体资源的路径。
+     * @param event 预加载媒体资源时发生的事件。详见 PlayerPreloadEvent 。
+     */
+    onPreloadEvent?(src: string, event: PlayerPreloadEvent): void;
+    /**
+     * @ignore
+     */
+    onCompleted?(): void;
+    /**
+     * @ignore
+     */
+    onAgoraCDNTokenWillExpire?(): void;
+    /**
+     * 媒体资源视频码率变化回调。
+     *
+     * @param from 变化前，媒体资源播放时的视频码率相关信息。详见 SrcInfo 。
+     * @param to 变化后，媒体资源播放时的视频码率相关信息。详见 SrcInfo 。
+     */
+    onPlayerSrcInfoChanged?(from: SrcInfo, to: SrcInfo): void;
+    /**
+     * 媒体播放器相关信息发生改变回调。
+     *
+     * 当媒体播放器相关信息发生改变时，SDK 会触发该回调。你可用其进行问题定位和排查。
+     *
+     * @param info 媒体播放器相关信息。详见 PlayerUpdatedInfo 。
+     */
+    onPlayerInfoUpdated?(info: PlayerUpdatedInfo): void;
+    /**
+     * 报告当前缓存中的媒体资源的相关信息。
+     *
+     * 调用 openWithMediaSource 方法且设置 enableCache 成员为 true 后，SDK 会在媒体文件打开后每秒触发一次该回调，报告当前缓存的媒体文件的统计数据。
+     *
+     * @param stats 缓存中的媒体资源的相关信息，详见 CacheStatistics 。
+     */
+    onPlayerCacheStats?(stats: CacheStatistics): void;
+    /**
+     * 报告当前播放的媒体资源的相关信息。
+     *
+     * 当媒体资源开始播放后，SDK 会每秒触发一次该回调，报告媒体资源的相关信息。
+     *
+     * @param stats 媒体资源的相关信息，详见 PlayerPlaybackStats 。
+     */
+    onPlayerPlaybackStats?(stats: PlayerPlaybackStats): void;
+    /**
+     * 媒体播放器音量提示回调。
+     *
+     * SDK 每 200 毫秒触发一次该回调，报告媒体播放器当前的音量。
+     *
+     * @param volume 播放器的当前音量，取值范围为 [0,255]。
+     */
+    onAudioVolumeIndication?(volume: number): void;
+}
+//# sourceMappingURL=IAgoraMediaPlayerSource.d.ts.map

package/types/Private/IAgoraMediaPlayerSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAgoraMediaPlayerSource.d.ts","sourceRoot":"","sources":["../../ts/Private/IAgoraMediaPlayerSource.ts"],"names":[],"mappings":"AAAA,OAAO,8CAA8C,CAAC;AACtD,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,OAAO,EACR,MAAM,yBAAyB,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;;;;OAOG;IACH,0BAA0B,CAAC,CACzB,KAAK,EAAE,gBAAgB,EACvB,MAAM,EAAE,iBAAiB,GACxB,IAAI,CAAC;IAER;;;;;;;OAOG;IACH,iBAAiB,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAElE;;;;;;;;OAQG;IACH,aAAa,CAAC,CACZ,SAAS,EAAE,gBAAgB,EAC3B,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,GACd,IAAI,CAAC;IAER;;;;;;;OAOG;IACH,UAAU,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpD;;;;;;;;OAQG;IACH,mBAAmB,CAAC,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErD;;;;;OAKG;IACH,cAAc,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,WAAW,CAAC,IAAI,IAAI,CAAC;IAErB;;OAEG;IACH,yBAAyB,CAAC,IAAI,IAAI,CAAC;IAEnC;;;;;OAKG;IACH,sBAAsB,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1D;;;;;;OAMG;IACH,mBAAmB,CAAC,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEpD;;;;;;OAMG;IACH,kBAAkB,CAAC,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAElD;;;;;;OAMG;IACH,qBAAqB,CAAC,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEzD;;;;;;OAMG;IACH,uBAAuB,CAAC,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAChD"}

package/types/Private/IAgoraMediaRecorder.d.ts

@@ -0,0 +1,60 @@
+import './extension/IAgoraMediaRecorderExtension';
+import { IMediaRecorderObserver, MediaRecorderConfiguration } from './AgoraMediaBase';
+/**
+ * 提供本地及远端音视频录制功能的类。
+ */
+export declare abstract class IMediaRecorder {
+    /**
+     * 注册 IMediaRecorderObserver 观测器。
+     *
+     * 该方法用于设置音视频录制的回调，以便在录制过程中向 App 通知音视频流的录制状态和信息。
+     * 调用该方法前请确保：
+     *  已创建并初始化 IRtcEngine 对象。
+     *  已通过 createMediaRecorder 创建音视频录制对象。
+     *
+     * @param callback 音视频流录制回调，详见 IMediaRecorderObserver 。
+     *
+     * @returns
+     * 0: 方法调用成功。
+     *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/electron/error-code)了解详情和解决建议。
+     */
+    abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number;
+    /**
+     * 开启音视频流录制。
+     *
+     * 该方法用于开启音视频流录制。声网 SDK 支持同时录制本地及远端用户的音视频流。
+     * 在开始录制前请确保：
+     *  已通过 createMediaRecorder 创建音视频录制对象。
+     *  已调用 setMediaRecorderObserver 注册录制对象观测器来监听录制的相关回调。
+     *  已加入频道。 该方法支持录制如下数据：
+     *  麦克风采集的、AAC 编码格式的音频。
+     *  摄像头采集的、H.264 或 H.265 编码格式的视频。 开启音视频流录制后，当视频分辨率在录制过程中发生变化时，SDK 会停止录制；当音频采样率和声道数发生变化时，SDK 会持续录制并生成单个 MP4 录制文件。 仅当检测到可录制的音视频流时，才能成功生成录制文件；如果没有可录制的音视频流，或在录制过程中的音视频流中断超过 5 秒后，SDK 会停止录制，并触发 onRecorderStateChanged (RecorderStateError, RecorderErrorNoStream) 回调。
+     *  如果你需要录制的是本地的音视频流，请在开始录制前确保本地用户的角色设为主播。
+     *  如果你需要录制的是远端用户的音视频流，请在开始录制前确保已经订阅了该用户的音视频流。
+     *
+     * @param config 音视频流录制配置。详见 MediaRecorderConfiguration 。
+     *
+     * @returns
+     * 0: 方法调用成功。
+     *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/electron/error-code)了解详情和解决建议。
+     *  -2: 参数无效。请确保：
+     *  指定的录制文件保存路径正确且可写。
+     *  指定的录制文件格式正确。
+     *  设置的最大录制时长正确。
+     *  -4: IRtcEngine 当前状态不支持该操作。可能因为录制正在进行中或录制出错停止。
+     *  -7: IRtcEngine 尚未初始化就调用方法。请确认在调用该方法前已创建 IMediaRecorder 对象。
+     */
+    abstract startRecording(config: MediaRecorderConfiguration): number;
+    /**
+     * 停止音视频流录制。
+     *
+     * 调用 startRecording 后，如果要停止录制，请调用该方法停止录制；否则，生成的录制文件可能无法正常播放。
+     *
+     * @returns
+     * 0: 方法调用成功。
+     *  < 0: 方法调用失败：
+     *  -7: IRtcEngine 尚未初始化就调用方法。请确认在调用该方法前已创建 IMediaRecorder 对象。
+     */
+    abstract stopRecording(): number;
+}
+//# sourceMappingURL=IAgoraMediaRecorder.d.ts.map

package/types/Private/IAgoraMediaRecorder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAgoraMediaRecorder.d.ts","sourceRoot":"","sources":["../../ts/Private/IAgoraMediaRecorder.ts"],"names":[],"mappings":"AAAA,OAAO,0CAA0C,CAAC;AAClD,OAAO,EACL,sBAAsB,EACtB,0BAA0B,EAC3B,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,8BAAsB,cAAc;IAClC;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,wBAAwB,CAAC,QAAQ,EAAE,sBAAsB,GAAG,MAAM;IAE3E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,0BAA0B,GAAG,MAAM;IAEnE;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,IAAI,MAAM;CACjC"}

package/types/Private/IAgoraMediaStreamingSource.d.ts

@@ -0,0 +1,42 @@
+import './extension/IAgoraMediaStreamingSourceExtension';
+export declare enum StreamingSrcErr {
+    StreamingSrcErrNone = 0,
+    StreamingSrcErrUnknown = 1,
+    StreamingSrcErrInvalidParam = 2,
+    StreamingSrcErrBadState = 3,
+    StreamingSrcErrNoMem = 4,
+    StreamingSrcErrBufferOverflow = 5,
+    StreamingSrcErrBufferUnderflow = 6,
+    StreamingSrcErrNotFound = 7,
+    StreamingSrcErrTimeout = 8,
+    StreamingSrcErrExpired = 9,
+    StreamingSrcErrUnsupported = 10,
+    StreamingSrcErrNotExist = 11,
+    StreamingSrcErrExist = 12,
+    StreamingSrcErrOpen = 13,
+    StreamingSrcErrClose = 14,
+    StreamingSrcErrRead = 15,
+    StreamingSrcErrWrite = 16,
+    StreamingSrcErrSeek = 17,
+    StreamingSrcErrEof = 18,
+    StreamingSrcErrCodecopen = 19,
+    StreamingSrcErrCodecclose = 20,
+    StreamingSrcErrCodecproc = 21
+}
+export declare enum StreamingSrcState {
+    StreamingSrcStateClosed = 0,
+    StreamingSrcStateOpening = 1,
+    StreamingSrcStateIdle = 2,
+    StreamingSrcStatePlaying = 3,
+    StreamingSrcStateSeeking = 4,
+    StreamingSrcStateEof = 5,
+    StreamingSrcStateError = 6
+}
+export declare class InputSeiData {
+    type?: number;
+    timestamp?: number;
+    frame_index?: number;
+    private_data?: Uint8Array;
+    data_size?: number;
+}
+//# sourceMappingURL=IAgoraMediaStreamingSource.d.ts.map

package/types/Private/IAgoraMediaStreamingSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAgoraMediaStreamingSource.d.ts","sourceRoot":"","sources":["../../ts/Private/IAgoraMediaStreamingSource.ts"],"names":[],"mappings":"AAAA,OAAO,iDAAiD,CAAC;AAGzD,oBAAY,eAAe;IAEzB,mBAAmB,IAAI;IAEvB,sBAAsB,IAAI;IAE1B,2BAA2B,IAAI;IAE/B,uBAAuB,IAAI;IAE3B,oBAAoB,IAAI;IAExB,6BAA6B,IAAI;IAEjC,8BAA8B,IAAI;IAElC,uBAAuB,IAAI;IAE3B,sBAAsB,IAAI;IAE1B,sBAAsB,IAAI;IAE1B,0BAA0B,KAAK;IAE/B,uBAAuB,KAAK;IAE5B,oBAAoB,KAAK;IAEzB,mBAAmB,KAAK;IAExB,oBAAoB,KAAK;IAEzB,mBAAmB,KAAK;IAExB,oBAAoB,KAAK;IAEzB,mBAAmB,KAAK;IAExB,kBAAkB,KAAK;IAEvB,wBAAwB,KAAK;IAE7B,yBAAyB,KAAK;IAE9B,wBAAwB,KAAK;CAC9B;AAGD,oBAAY,iBAAiB;IAE3B,uBAAuB,IAAI;IAE3B,wBAAwB,IAAI;IAE5B,qBAAqB,IAAI;IAEzB,wBAAwB,IAAI;IAE5B,wBAAwB,IAAI;IAE5B,oBAAoB,IAAI;IAExB,sBAAsB,IAAI;CAC3B;AAGD,qBAAa,YAAY;IAEvB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,YAAY,CAAC,EAAE,UAAU,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}