fcr-ui-scene 3.4.0 → 3.4.2

package/lib/providers/interpreter-provider.d.ts

@@ -0,0 +1,236 @@
+import { FcrUIJoinInterpreterRoom, FcrUILeaveInterpreterRoom } from '../type';
+import { FcrInterpreterControl, FcrInterpreterUserInfo } from 'fcr-core/lib/room-control/interpreter-control/types';
+import { FcrError, FcrStreamControl } from 'fcr-core';
+import { FcrUIPrivilegeProvider } from './privilege-provider';
+import { FcrInterpreterUsersParams } from 'fcr-core/lib/room-control/interpreter-control/types';
+import { FcrLanguage } from 'fcr-core/lib/room-control/interpreter-control/types';
+import { FcrUserControl } from 'fcr-core/lib/room-control/user-control/type';
+import { FcrUISharedInterpreterDataSource, FcrUILanguage } from '../shared-data-source/interpreter';
+import { FcrUserInfo } from 'fcr-core/lib/type';
+import { FcrUIEventProvider } from './event-provider';
+import { FcrUIDeviceProvider } from './device-provider';
+import { FcrUIDevicePrivilegeProvider } from './device-privilege-provider';
+export type FcrUIInterpreterRoomObserver = {
+    /**
+     * 开始加入翻译官房间
+     * @param param
+     * @returns
+     */
+    onJoinInterpretingRoom?: (param: FcrUIJoinInterpreterRoom) => void;
+    /**
+     * 加入翻译官房间成功
+     * @param param
+     * @returns
+     */
+    onJoinInterpretingRoomSuccess?: (param: FcrUIJoinInterpreterRoom) => void;
+    /**
+     * 加入翻译官房间失败
+     * @param param
+     * @returns
+     */
+    onJoinInterpretingRoomFailed?: (param: FcrUIJoinInterpreterRoom) => void;
+    /**
+     * 开始离开翻译官房间
+     * @param param
+     * @returns
+     */
+    onLeaveInterpretingRoom?: (param: FcrUILeaveInterpreterRoom) => void;
+    /**
+     * 离开翻译官房间成功
+     * @param param
+     * @returns
+     */
+    onLeaveInterpretingRoomFailed?: (param: FcrUILeaveInterpreterRoom) => void;
+    /**
+     * 离开翻译官房间失败
+     * @param param
+     * @returns
+     */
+    onLeaveInterpretingRoomSuccess?: (param: FcrUILeaveInterpreterRoom) => void;
+    /**
+     * 同声传译开启
+     * @returns
+     */
+    onInterpretationEnabled?: (interpreterList: FcrInterpreterUserInfo[], operatorUser: FcrUserInfo) => void;
+    /**
+     * 关闭同声传译
+     * @returns
+     */
+    onInterpretationDisabled?: (operatorUser: FcrUserInfo) => void;
+    /**
+     * 翻译官列表更新
+     * @returns
+     */
+    onInterpreterListUpdated?: (interpreterList: FcrInterpreterUserInfo[], operatorUser: FcrUserInfo) => void;
+    /**
+     *当前正在翻译的语言列表更新
+     * @returns
+     */
+    onSubscribeLanguageListUpdated?: (languageList: FcrUILanguage[]) => void;
+    /**
+     *翻译的语言音量是否优先增强（抑制原语言音量）
+     * @returns
+     */
+    onSubscribeLanguageVolumePrioritized?(enable: boolean): void;
+    /**
+     *本地用户在加入房间前就已经是翻译官
+     * @returns
+     */
+    onLocalBecameInterpreter?(supportedLanguages: FcrLanguage[], outputLanguage: FcrLanguage): void;
+    /**
+     *本地用户成为翻译官
+     * @returns
+     */
+    onLocalBecomeInterpreter?(supportedLanguages: FcrLanguage[], outputLanguage: FcrLanguage): void;
+    /**
+     *本地用户为翻译官时，翻译官的输出语言即将发生变化时触发该回调（被动的时候触发该回调）
+     * @returns
+     */
+    onLocalInterpreterWillUpdate?(outputLanguage: FcrLanguage): void;
+    /**
+     *：本地用户为翻译官时，翻译官的输出语言发生变化时触发该回调（主动与被动都触发该回调）
+     * @returns
+     */
+    onLocalInterpreterUpdated?(supportedLanguages: FcrLanguage[], outputLanguage: FcrLanguage): void;
+    /**
+     *本地用户不再是翻译官（从翻译官变为非翻译官会触发该回调）
+     * @returns
+     */
+    onLocalNotInterpreter?(): void;
+    /**
+     *本地用户新增订阅的语言
+     * @returns
+     */
+    onLanguageSubscribed?(language: FcrUILanguage): void;
+    /**
+     *本地用户取消订阅的语言
+     * @returns
+     */
+    onLanguageUnsubscribed?(language: FcrUILanguage): void;
+};
+export interface FcrUIInterpreterProvider {
+    addObserver(observer: FcrUIInterpreterRoomObserver): void;
+    removeObserver(observer: FcrUIInterpreterRoomObserver): void;
+    /**
+     * 是否有权限开启同声传译功能
+     */
+    canEnableInterpretation(): boolean;
+    /**
+     * 设置翻译员（全量数据），同时开启同声传译
+     */
+    setInterpreterUsers(params: FcrInterpreterUsersParams[], successCallback?: () => void, failureCallback?: (error: FcrError) => void): Promise<void>;
+    /**
+     * 关闭同声传译
+     */
+    disableInterpretation(): void;
+    /**
+     * 同声传译开启状态（开 or 关）
+     */
+    getInterpretationState(): boolean;
+    /**
+     * 本地是翻译官时，切换输出语言
+     * @returns {boolean} - 可以切换语言，返回 true；否则返回 false
+     */
+    setOutputLanguage(language: FcrLanguage, successCallback?: () => void, failureCallback?: (error: FcrError) => void): Promise<boolean>;
+    /**
+     * 订阅语言频道
+     */
+    subscribeLanguage(language: FcrUILanguage, successCallback?: () => void, failureCallback?: (error: FcrError) => void): Promise<void>;
+    /**
+     * 额外订阅原生语言频道
+     */
+    subscribeExtraOriginLanguage(subscribe: boolean): void;
+    /**
+     * 额外订阅原生语言频道
+     */
+    getHasSubscribedLanguageList(): FcrUILanguage[];
+    /**
+     * 用户是否是翻译员
+     *   @returns {boolean} - 用户是翻译员，返回 true；否则返回 false
+     */
+    userIsInterpreter(userId: string): boolean;
+    /**
+     * 获取翻译官当前的输出语言
+     *   @param {string} userId - 用户ID
+     *   @returns {FcrUILanguage}
+     */
+    getUserOutputLanguage(userId: string): FcrUILanguage;
+    /**
+     * 获取所有翻译官列表
+     *   @returns {FcrInterpreterUserInfo[]}
+     */
+    getInterpreterList(): FcrInterpreterUserInfo[] | null;
+    /**
+     * 当前可以订阅的语言列表
+     *   @returns {FcrUILanguage[]}
+     */
+    getSubscribeLanguageList(): FcrUILanguage[];
+    /**
+     * 获取设置输出语言选项的列表
+     *   @returns {FcrLanguage[]}
+     */
+    getOutputLanguageOptionList(): FcrLanguage[];
+}
+interface FcrUIInterpreterProviderImplParams {
+    privilegeProvider: FcrUIPrivilegeProvider;
+    interpreterControl: FcrInterpreterControl;
+    userControl: FcrUserControl;
+    sharedInterpreterDataSource: FcrUISharedInterpreterDataSource;
+    eventProvider: FcrUIEventProvider;
+    streamControl: FcrStreamControl;
+    deviceProvider: FcrUIDeviceProvider;
+    devicePrivilegeProvider: FcrUIDevicePrivilegeProvider;
+}
+export declare class FcrUIInterpreterProviderImpl implements FcrUIInterpreterProvider {
+    private _observable;
+    private _privilegeProvider;
+    private _interpreterControl;
+    private _userControl;
+    private _sharedInterpreterDataSource;
+    private _eventProvider;
+    private _mainStreamControl;
+    private _deviceProvider;
+    private _devicePrivilegeProvider;
+    private _languageRoomListByStatus;
+    private _indicateTimerId;
+    private _volumeTimerId;
+    private _hasSubscribedLanguageList;
+    private _observerStream;
+    private _observerMicrophoneChanged;
+    private _observerInterpreter;
+    private _retryTask;
+    constructor(params: FcrUIInterpreterProviderImplParams);
+    private _publishEvent;
+    private _triggerDvicePrivilege;
+    private _mount;
+    private _update;
+    _unload(): void;
+    private _clearTimer;
+    private _onStreamVolumeIndicationUpdated;
+    private _updateLanguageRoomListByStatus;
+    private _clearRetryTaskTimer;
+    private _getRoomInfo;
+    private _bindLocalMicrophoneId;
+    private _joinInterpreterRoom;
+    private _leaveInterpreterRoom;
+    private _setMainRoomStream;
+    _updateOutputLanguage(language: FcrLanguage | null, isLocalOperation?: boolean): Promise<void>;
+    _updateSubscribeLanguage(languageList: FcrUILanguage[]): Promise<void>;
+    setOutputLanguage(language: FcrLanguage, successCallback?: () => void, failureCallback?: (error: FcrError) => void): Promise<boolean>;
+    subscribeLanguage(language: FcrUILanguage, successCallback?: () => void, failureCallback?: (error: FcrError) => void): Promise<void>;
+    subscribeExtraOriginLanguage(subscribe: boolean): void;
+    getHasSubscribedLanguageList(): FcrUILanguage[];
+    userIsInterpreter(userId: string): boolean;
+    getUserOutputLanguage(userId: string): FcrUILanguage;
+    getSubscribeLanguageList(): FcrUILanguage[];
+    getOutputLanguageOptionList(): FcrLanguage[];
+    setInterpreterUsers(params: FcrInterpreterUsersParams[], successCallback?: () => void, failureCallback?: (error: FcrError) => void): Promise<void>;
+    disableInterpretation(): void;
+    getInterpretationState(): boolean;
+    getInterpreterList(): FcrInterpreterUserInfo[] | null;
+    addObserver(observer: FcrUIInterpreterRoomObserver): void;
+    removeObserver(observer: FcrUIInterpreterRoomObserver): void;
+    canEnableInterpretation(): boolean;
+    release(): void;
+}
+export {};