media-av 0.0.13 → 0.0.14

package/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2023-present, w.w.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+The MIT License (MIT)
+
+Copyright (c) 2023-present, w.w.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.

package/README.md

@@ -1,15 +1,15 @@
-# 本接口需要后台服务端支持
-
-1. 支持通过http+flv拉流
-2. 支持通过webrtc接流
-3. 支持软电话,实现音视频呼叫
-4. 支持音视频全双工半/双工呼叫
-
-2024/01/26   0.0.13
-1. 新增app代理, 支持音视频全双工/半双工呼叫
-
-2023/09/04
-1. 新增广播喊话
-
-# 使用用例
+# 本接口需要后台服务端支持
+
+1. 支持通过http+flv拉流
+2. 支持通过webrtc接流
+3. 支持软电话,实现音视频呼叫
+4. 支持音视频全双工半/双工呼叫
+
+2024/01/26   0.0.13
+1. 新增app代理, 支持音视频全双工/半双工呼叫
+
+2023/09/04
+1. 新增广播喊话
+
+# 使用用例
 https://gitee.com/slad__shang/media-av-demo

package/index.d.ts

@@ -1,354 +1,358 @@
-
-export interface RtspPullSessionListener {
-    /**
-     * 错误回调
-     * @param err{Error}
-     */
-    onError(err: Error): void;
-    /**
-     * 添加远端媒体流
-     * @param stream{MediaStream} 媒体流
-     */
-    onAddRemoteStream(stream: MediaStream): void;
-}
-
-export interface IRtspPullSession {
-    /**
-     * 添加回调监听
-     * @param listener 监听器
-     */
-    setRtspPullSessionListener(listener: RtspPullSessionListener): void;
-
-    /**
-     * 开始拉流
-     */
-    start(): void;
-
-    /**
-     * 停止拉流
-     */
-    stop(): void;
-}
-
-export interface BroadcastSessionListener {
-
-    /**
-     * 视频推送时会上报
-     * @param stream
-     */
-    onAddLocalStream(stream: MediaStream): void
-
-    /**
-     * 错误回调
-     * @param err{Error}
-     */
-    onError(err: Error): void
-}
-
-export interface IBroadcastSession {
-    /**
-     * 添加回调监听
-     * @param listener 监听器
-     */
-    setBroadcastSessionListener(listener: BroadcastSessionListener): void;
-
-    /**
-     * 开始广播
-     */
-    start(): void;
-
-    /**
-     * 停止广播
-     */
-    stop(): void;
-}
-
-/**
- * in  呼入
- * out 呼出
- */
-type CallDirect = "in" | "out";
-
-/**
- * full-duplex   全双工
- * half-duplex   半双工(对讲)
- */
-type CallMode = "full-duplex" | "half-duplex"
-
-/**
- * video   视频
- * audio   语音
- */
-type MediaType = "video" | "audio"
-
-/**
- *     -1 离线
- *     0  空闲
- *     1  呼叫中
- *     2  振铃
- *     3  通话
- */
-type SessionStatus = -1 | 0 | 1 | 2 | 3
-
-export class CallInfo {
-    /**
-     * 对方号码
-     */
-    tel: string;
-    /**
-     * 呼叫媒体类型
-     */
-    mediaType: MediaType;
-    /**
-     * 呼叫模式
-     */
-    callMode: CallMode;
-    constructor(tel: string, mediaType: MediaType, callMode: CallMode);
-}
-
-/**
- * tb_granted 申请话权成功
- * tb_taken   其他人申请话权成功
- * tb_deny    申请话权失败
- * tb_idle    空闲,没有人说话
- * tb_revoke  话权被抢
- */
-type ETbcpType = "tb_granted" | "tb_taken" | "tb_deny" | "tb_idle" | "tb_revoke"
-
-export interface ITbcpMessage {
-    /**
-     * 话权类型
-     */
-    type : ETbcpType
-
-    callId ?: string
-
-    /**
-     * 其他信息
-     * type -> tb_taken: 申请话权成功之人的号码
-     * 其他类型暂时不用处理此字段
-     */
-    info ?: string
-}
-
-export interface CallSessionListener {
-    /**
-     * 初始化结果回调
-     * @param result   true 成功 false 失败
-     */
-    onInitResult(result: boolean): void;
-
-    /**
-     * 对方振铃,呼出时有回调
-     */
-    onRing(): void;
-
-    /**
-     * 对方接听,呼出时有回调
-     */
-    onAnswer(): void;
-    /**
-     * 1. 呼叫失败
-     * 2. 呼出时，对方还没有接听前，对方拒绝接听
-     * 3. 呼入/呼出时，通话接束后，对方挂机
-     * 4. 呼入时，还没有接听，对方取消呼叫
-     * @param reason 挂机原因
-     */
-    onHangup(reason?: Number): void;
-
-    /**
-     * 收到对方呼入电话
-     * @param callInfo 呼入信息
-     */
-    onNewCall(callInfo: CallInfo): void;
-
-    /**
-     * 呼叫过程发生错误
-     * @param err 错误原因
-     */
-    onError(err: Error): void;
-
-    /**
-     * 添加本地视频流,视频呼叫时收到
-     * 建议video标签静音,不然会听到自己的声音
-     * @param stream
-     */
-    onAddRemoteStream(stream: MediaStream): void;
-
-    /**
-     * 添加远端音视频流
-     * @param stream
-     */
-    onAddLocalStream(stream: MediaStream): void;
-
-    /**
-     * 会话连接关闭
-     * @param reason 关闭原因
-     */
-    onClose(reason: Error): void;
-}
-
-export interface AppCallSessionListener extends CallSessionListener {
-    /**
-     * 话权消息回调
-     * @param msg
-     */
-    onTbcpMessage(msg: ITbcpMessage): void
-}
-
-export interface ICallSession {
-    /**
-     * 本会话的号码
-     */
-    readonly tel: string;
-
-    /**
-     * 会话当前状态
-     */
-    readonly status: SessionStatus;
-
-    /**
-     * 会话呼叫类型
-     */
-    readonly mediaType: MediaType;
-
-    /**
-     * 会话呼叫方向
-     */
-    readonly callDirect: CallDirect;
-
-    /**
-     * 设置回调监听
-     * @param listener 监听器
-     */
-    setCallSessionListener(listener: CallSessionListener): void;
-
-    /**
-     * 初始化
-     */
-    init(): void;
-
-    /**
-     * 发起呼叫
-     * @param called    要呼叫的号码
-     * @param mediaType 呼叫类型
-     * @param callMode  呼叫模式
-     */
-    makeCall(called: string, mediaType?: MediaType, callMode?: CallMode): void;
-
-    /**
-     * 应答
-     */
-    answer(): void;
-
-    /**
-     * 挂机/拒绝接听
-     */
-    hangup(): void;
-
-    /**
-     * 发送dtmf
-     * @param dtmf{string} 要发送的按键值 0-9 * #
-     */
-    dtmf(dtmf: string): boolean;
-
-    /**
-     * 转换前后置摄像头
-     * @returns {Promise<string>}
-     * @constructor
-     */
-    changeCamera(): Promise<string>;
-
-    /**
-     * 改变麦克风状态
-     * @returns {Promise<boolean>}
-     * @constructor
-     */
-    changeMuted(): Promise<boolean>;
-
-    /**
-     * 改变本地摄像头状态, 打开或关闭本地摄像头
-     * @returns {Promise<boolean>}
-     * @constructor
-     */
-    changeCameraOpened(): Promise<boolean>;
-
-    /**
-     * 注销
-     */
-    destroy():void;
-}
-
-export interface IAppCallSession extends ICallSession {
-    /**
-     * 会话呼叫模式
-     */
-    readonly callMode: CallMode;
-
-    /**
-     * 设置回调监听
-     * @param listener 监听器
-     */
-    setCallSessionListener(listener: AppCallSessionListener): void;
-
-    /**
-     * 发起语音对讲呼叫
-     * @param called    要呼叫的号码
-     */
-    audioHalfCall(called : string): void
-
-    /**
-     * 发起视频对讲呼叫
-     * @param called    要呼叫的号码
-     */
-    videoHalfCall(called : string): void
-
-    /**
-     * 申请话权
-     */
-    tbcpRequest(): void;
-
-    /**
-     * 释放话权
-     */
-    tbcpRelease(): void;
-}
-
-/**
- * 初始化voip模块
- * @param baseUrl{string} ws(s)://ip:port
- */
-export declare function voipModuleInit(baseUrl: string): void;
-
-/**
- * 创建呼叫会话
- * @param tel 本端号码,可为空由服务端随机分配
- */
-export declare function createCallSession(tel?: string): ICallSession;
-
-/**
- * 创建app会话
- * @param tel 账号配置的app号码
- * @param accountId 账号id
- */
-export declare function createAppCallSession(tel:string, accountId:string): IAppCallSession;
-
-/**
- * 初始化video模块
- * @param baseUrl{string} http(s)://ip:port
- */
-export declare function videoModuleInit(baseUrl: string): void;
-
-/**
- * 创建rtsp拉流会话
- * @param rtspUrl{string} rtsp地址
- */
-export declare function createRtspPullSession(rtspUrl: string): IRtspPullSession;
-
-
-/**
- * 创建广播会话
- * @param tel 广播号码
- * @param mediaType 广播类型, 默认 audio
- */
+
+export interface RtspPullSessionListener {
+    /**
+     * 错误回调
+     * @param err{Error}
+     */
+    onError(err: Error): void;
+    /**
+     * 添加远端媒体流
+     * @param stream{MediaStream} 媒体流
+     */
+    onAddRemoteStream(stream: MediaStream): void;
+}
+
+export interface IRtspPullSession {
+    /**
+     * 添加回调监听
+     * @param listener 监听器
+     */
+    setRtspPullSessionListener(listener: RtspPullSessionListener): void;
+
+    /**
+     * 开始拉流
+     */
+    start(): void;
+
+    /**
+     * 停止拉流
+     */
+    stop(): void;
+}
+
+export interface BroadcastSessionListener {
+
+    /**
+     * 视频推送时会上报
+     * @param stream
+     */
+    onAddLocalStream(stream: MediaStream): void
+
+    /**
+     * 错误回调
+     * @param err{Error}
+     */
+    onError(err: Error): void
+}
+
+export interface IBroadcastSession {
+    /**
+     * 添加回调监听
+     * @param listener 监听器
+     */
+    setBroadcastSessionListener(listener: BroadcastSessionListener): void;
+
+    /**
+     * 开始广播
+     */
+    start(): void;
+
+    /**
+     * 停止广播
+     */
+    stop(): void;
+}
+
+/**
+ * in  呼入
+ * out 呼出
+ */
+type CallDirect = "in" | "out";
+
+/**
+ * full-duplex   全双工
+ * half-duplex   半双工(对讲)
+ */
+type CallMode = "full-duplex" | "half-duplex"
+
+/**
+ * video   视频
+ * audio   语音
+ */
+type MediaType = "video" | "audio"
+
+/**
+ *     -1 离线
+ *     0  空闲
+ *     1  呼叫中
+ *     2  振铃
+ *     3  通话
+ */
+type SessionStatus = -1 | 0 | 1 | 2 | 3
+
+export class CallInfo {
+    /**
+     * 对方号码
+     */
+    tel: string;
+    /**
+     * 呼叫媒体类型
+     */
+    mediaType: MediaType;
+    /**
+     * 呼叫模式
+     */
+    callMode: CallMode;
+    constructor(tel: string, mediaType: MediaType, callMode: CallMode);
+}
+
+/**
+ * tb_granted 申请话权成功
+ * tb_taken   其他人申请话权成功
+ * tb_deny    申请话权失败
+ * tb_idle    空闲,没有人说话
+ * tb_revoke  话权被抢
+ */
+type ETbcpType = "tb_granted" | "tb_taken" | "tb_deny" | "tb_idle" | "tb_revoke"
+
+export interface ITbcpMessage {
+    /**
+     * 话权类型
+     */
+    type : ETbcpType
+
+    callId ?: string
+
+    /**
+     * 其他信息
+     * type -> tb_taken: 申请话权成功之人的号码
+     * 其他类型暂时不用处理此字段
+     */
+    info ?: string
+}
+
+export interface CallSessionListener {
+    /**
+     * 初始化结果回调
+     * @param result   true 成功 false 失败
+     */
+    onInitResult(result: boolean): void;
+
+    /**
+     * 对方振铃,呼出时有回调
+     */
+    onRing(): void;
+
+    /**
+     * 对方接听,呼出时有回调
+     */
+    onAnswer(): void;
+    /**
+     * 1. 呼叫失败
+     * 2. 呼出时，对方还没有接听前，对方拒绝接听
+     * 3. 呼入/呼出时，通话接束后，对方挂机
+     * 4. 呼入时，还没有接听，对方取消呼叫
+     * @param reason 挂机原因
+     */
+    onHangup(reason?: Number): void;
+
+    /**
+     * 收到对方呼入电话
+     * @param callInfo 呼入信息
+     */
+    onNewCall(callInfo: CallInfo): void;
+
+    /**
+     * 呼叫过程发生错误
+     * @param err 错误原因
+     */
+    onError(err: Error): void;
+
+    /**
+     * 添加本地视频流,视频呼叫时收到
+     * 建议video标签静音,不然会听到自己的声音
+     * @param stream
+     */
+    onAddRemoteStream(stream: MediaStream): void;
+
+    /**
+     * 添加远端音视频流
+     * @param stream
+     */
+    onAddLocalStream(stream: MediaStream): void;
+
+    /**
+     * 会话连接关闭
+     * @param reason 关闭原因
+     */
+    onClose(reason: Error): void;
+}
+
+export interface AppCallSessionListener extends CallSessionListener {
+    /**
+     * 话权消息回调
+     * @param msg
+     */
+    onTbcpMessage(msg: ITbcpMessage): void
+}
+
+export interface ICallSession {
+    /**
+     * 本会话的号码
+     */
+    readonly tel: string;
+
+    /**
+     * 会话当前状态
+     */
+    readonly status: SessionStatus;
+
+    /**
+     * 会话呼叫类型
+     */
+    readonly mediaType: MediaType;
+
+    /**
+     * 会话呼叫方向
+     */
+    readonly callDirect: CallDirect;
+
+    /**
+     * 设置回调监听
+     * @param listener 监听器
+     */
+    setCallSessionListener(listener: CallSessionListener): void;
+
+    /**
+     * 初始化
+     */
+    init(): void;
+
+    /**
+     * 发起语音呼叫
+     * @param called    要呼叫的号码
+     */
+    audioCall(called : string): void
+
+    /**
+     * 发起视频呼叫
+     * @param called    要呼叫的号码
+     */
+    videoCall(called : string): void
+
+    /**
+     * 应答
+     */
+    answer(): void;
+
+    /**
+     * 挂机/拒绝接听
+     */
+    hangup(): void;
+
+    /**
+     * 发送dtmf
+     * @param dtmf{string} 要发送的按键值 0-9 * #
+     */
+    dtmf(dtmf: string): boolean;
+
+    /**
+     * 转换前后置摄像头
+     * @returns {Promise<string>}
+     * @constructor
+     */
+    changeCamera(): Promise<string>;
+
+    /**
+     * 改变麦克风状态
+     * @returns {Promise<boolean>}
+     * @constructor
+     */
+    changeMuted(): Promise<boolean>;
+
+    /**
+     * 改变本地摄像头状态, 打开或关闭本地摄像头
+     * @returns {Promise<boolean>}
+     * @constructor
+     */
+    changeCameraOpened(): Promise<boolean>;
+
+    /**
+     * 注销
+     */
+    destroy():void;
+}
+
+export interface IAppCallSession extends ICallSession {
+    /**
+     * 会话呼叫模式
+     */
+    readonly callMode: CallMode;
+
+    /**
+     * 设置回调监听
+     * @param listener 监听器
+     */
+    setCallSessionListener(listener: AppCallSessionListener): void;
+
+    /**
+     * 发起语音对讲呼叫
+     * @param called    要呼叫的号码
+     */
+    audioHalfCall(called : string): void
+
+    /**
+     * 发起视频对讲呼叫
+     * @param called    要呼叫的号码
+     */
+    videoHalfCall(called : string): void
+
+    /**
+     * 申请话权
+     */
+    tbcpRequest(): void;
+
+    /**
+     * 释放话权
+     */
+    tbcpRelease(): void;
+}
+
+/**
+ * 初始化voip模块
+ * @param baseUrl{string} ws(s)://ip:port
+ */
+export declare function voipModuleInit(baseUrl: string): void;
+
+/**
+ * 创建呼叫会话
+ * @param tel 本端号码,可为空由服务端随机分配
+ */
+export declare function createCallSession(tel?: string): ICallSession;
+
+/**
+ * 创建app会话
+ * @param tel 账号配置的app号码
+ * @param accountId 账号id
+ */
+export declare function createAppCallSession(tel:string, accountId:string): IAppCallSession;
+
+/**
+ * 初始化video模块
+ * @param baseUrl{string} http(s)://ip:port
+ */
+export declare function videoModuleInit(baseUrl: string): void;
+
+/**
+ * 创建rtsp拉流会话
+ * @param rtspUrl{string} rtsp地址
+ */
+export declare function createRtspPullSession(rtspUrl: string): IRtspPullSession;
+
+
+/**
+ * 创建广播会话
+ * @param tel 广播号码
+ * @param mediaType 广播类型, 默认 audio
+ */
 export declare function createBroadcastSession(tel: string, mediaType?: MediaType): IBroadcastSession;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "media-av",
   "private": false,
-  "version": "0.0.13",
+  "version": "0.0.14",
   "type": "module",
   "author": "W.w.",
   "license": "MIT",