agora-electron-sdk 0.0.0-dev.1

package/ts/Private/IAgoraMediaPlayerSource.ts

@@ -0,0 +1,137 @@
+import './extension/IAgoraMediaPlayerSourceExtension';
+import {
+  CacheStatistics,
+  MediaPlayerEvent,
+  MediaPlayerReason,
+  MediaPlayerState,
+  PlayerPlaybackStats,
+  PlayerPreloadEvent,
+  PlayerUpdatedInfo,
+  SrcInfo,
+} from './AgoraMediaPlayerTypes';
+
+/**
+ * Provides callbacks for media players.
+ */
+export interface IMediaPlayerSourceObserver {
+  /**
+   * Reports the changes of playback state.
+   *
+   * When the state of the media player changes, the SDK triggers this callback to report the current playback state.
+   *
+   * @param state The playback state. See MediaPlayerState.
+   * @param reason The reason for the changes in the media player status. See MediaPlayerReason.
+   */
+  onPlayerSourceStateChanged?(
+    state: MediaPlayerState,
+    reason: MediaPlayerReason
+  ): void;
+
+  /**
+   * Reports the playback progress of the media file.
+   *
+   * When playing media files, the SDK triggers this callback every two second to report current playback progress.
+   *
+   * @param positionMs The playback position (ms) of media files.
+   * @param timeStampMs The NTP timestamp (ms) of the current playback progress.
+   */
+  onPositionChanged?(positionMs: number, timestampMs: number): void;
+
+  /**
+   * Reports the player events.
+   *
+   * After calling the seek method, the SDK triggers the callback to report the results of the seek operation.
+   *
+   * @param eventCode The player event. See MediaPlayerEvent.
+   * @param elapsedTime The time (ms) when the event occurs.
+   * @param message Information about the event.
+   */
+  onPlayerEvent?(
+    eventCode: MediaPlayerEvent,
+    elapsedTime: number,
+    message: string
+  ): void;
+
+  /**
+   * Occurs when the media metadata is received.
+   *
+   * The callback occurs when the player receives the media metadata and reports the detailed information of the media metadata.
+   *
+   * @param data The detailed data of the media metadata.
+   * @param length The data length (bytes).
+   */
+  onMetaData?(data: Uint8Array, length: number): void;
+
+  /**
+   * Reports the playback duration that the buffered data can support.
+   *
+   * When playing online media resources, the SDK triggers this callback every two seconds to report the playback duration that the currently buffered data can support.
+   *  When the playback duration supported by the buffered data is less than the threshold (0 by default), the SDK returns PlayerEventBufferLow (6).
+   *  When the playback duration supported by the buffered data is greater than the threshold (0 by default), the SDK returns PlayerEventBufferRecover (7).
+   *
+   * @param playCachedBuffer The playback duration (ms) that the buffered data can support.
+   */
+  onPlayBufferUpdated?(playCachedBuffer: number): void;
+
+  /**
+   * Reports the events of preloaded media resources.
+   *
+   * @param src The URL of the media resource.
+   * @param event Events that occur when media resources are preloaded. See PlayerPreloadEvent.
+   */
+  onPreloadEvent?(src: string, event: PlayerPreloadEvent): void;
+
+  /**
+   * @ignore
+   */
+  onCompleted?(): void;
+
+  /**
+   * @ignore
+   */
+  onAgoraCDNTokenWillExpire?(): void;
+
+  /**
+   * Occurs when the video bitrate of the media resource changes.
+   *
+   * @param from Information about the video bitrate of the media resource being played. See SrcInfo.
+   * @param to Information about the changed video bitrate of media resource being played. See SrcInfo.
+   */
+  onPlayerSrcInfoChanged?(from: SrcInfo, to: SrcInfo): void;
+
+  /**
+   * Occurs when information related to the media player changes.
+   *
+   * When the information about the media player changes, the SDK triggers this callback. You can use this callback for troubleshooting.
+   *
+   * @param info Information related to the media player. See PlayerUpdatedInfo.
+   */
+  onPlayerInfoUpdated?(info: PlayerUpdatedInfo): void;
+
+  /**
+   * Reports the statistics of the media file being cached.
+   *
+   * After you call the openWithMediaSource method and set enableCache as true, the SDK triggers this callback once per second to report the statistics of the media file being cached.
+   *
+   * @param stats The statistics of the media file being cached. See CacheStatistics.
+   */
+  onPlayerCacheStats?(stats: CacheStatistics): void;
+
+  /**
+   * The statistics of the media file being played.
+   *
+   * The SDK triggers this callback once per second to report the statistics of the media file being played.
+   *
+   * @param stats The statistics of the media file. See PlayerPlaybackStats.
+   */
+  onPlayerPlaybackStats?(stats: PlayerPlaybackStats): void;
+
+  /**
+   * Reports the volume of the media player.
+   *
+   * The SDK triggers this callback every 200 milliseconds to report the current volume of the media player.
+   *
+   * @param volume The volume of the media player. The value ranges from 0 to 255.
+   */
+  onAudioVolumeIndication?(volume: number): void;
+}

package/ts/Private/IAgoraMediaRecorder.ts

@@ -0,0 +1,25 @@
+import './extension/IAgoraMediaRecorderExtension';
+import {
+  IMediaRecorderObserver,
+  MediaRecorderConfiguration,
+} from './AgoraMediaBase';
+
+/**
+ * @ignore
+ */
+export abstract class IMediaRecorder {
+  /**
+   * @ignore
+   */
+  abstract setMediaRecorderObserver(callback: IMediaRecorderObserver): number;
+
+  /**
+   * @ignore
+   */
+  abstract startRecording(config: MediaRecorderConfiguration): number;
+
+  /**
+   * @ignore
+   */
+  abstract stopRecording(): number;
+}

package/ts/Private/IAgoraMediaStreamingSource.ts

@@ -0,0 +1,81 @@
+import './extension/IAgoraMediaStreamingSourceExtension';
+
+/* enum_StreamingSrcErr */
+export enum StreamingSrcErr {
+  /* enum_StreamingSrcErr_StreamingSrcErrNone */
+  StreamingSrcErrNone = 0,
+  /* enum_StreamingSrcErr_StreamingSrcErrUnknown */
+  StreamingSrcErrUnknown = 1,
+  /* enum_StreamingSrcErr_StreamingSrcErrInvalidParam */
+  StreamingSrcErrInvalidParam = 2,
+  /* enum_StreamingSrcErr_StreamingSrcErrBadState */
+  StreamingSrcErrBadState = 3,
+  /* enum_StreamingSrcErr_StreamingSrcErrNoMem */
+  StreamingSrcErrNoMem = 4,
+  /* enum_StreamingSrcErr_StreamingSrcErrBufferOverflow */
+  StreamingSrcErrBufferOverflow = 5,
+  /* enum_StreamingSrcErr_StreamingSrcErrBufferUnderflow */
+  StreamingSrcErrBufferUnderflow = 6,
+  /* enum_StreamingSrcErr_StreamingSrcErrNotFound */
+  StreamingSrcErrNotFound = 7,
+  /* enum_StreamingSrcErr_StreamingSrcErrTimeout */
+  StreamingSrcErrTimeout = 8,
+  /* enum_StreamingSrcErr_StreamingSrcErrExpired */
+  StreamingSrcErrExpired = 9,
+  /* enum_StreamingSrcErr_StreamingSrcErrUnsupported */
+  StreamingSrcErrUnsupported = 10,
+  /* enum_StreamingSrcErr_StreamingSrcErrNotExist */
+  StreamingSrcErrNotExist = 11,
+  /* enum_StreamingSrcErr_StreamingSrcErrExist */
+  StreamingSrcErrExist = 12,
+  /* enum_StreamingSrcErr_StreamingSrcErrOpen */
+  StreamingSrcErrOpen = 13,
+  /* enum_StreamingSrcErr_StreamingSrcErrClose */
+  StreamingSrcErrClose = 14,
+  /* enum_StreamingSrcErr_StreamingSrcErrRead */
+  StreamingSrcErrRead = 15,
+  /* enum_StreamingSrcErr_StreamingSrcErrWrite */
+  StreamingSrcErrWrite = 16,
+  /* enum_StreamingSrcErr_StreamingSrcErrSeek */
+  StreamingSrcErrSeek = 17,
+  /* enum_StreamingSrcErr_StreamingSrcErrEof */
+  StreamingSrcErrEof = 18,
+  /* enum_StreamingSrcErr_StreamingSrcErrCodecopen */
+  StreamingSrcErrCodecopen = 19,
+  /* enum_StreamingSrcErr_StreamingSrcErrCodecclose */
+  StreamingSrcErrCodecclose = 20,
+  /* enum_StreamingSrcErr_StreamingSrcErrCodecproc */
+  StreamingSrcErrCodecproc = 21,
+}
+
+/* enum_StreamingSrcState */
+export enum StreamingSrcState {
+  /* enum_StreamingSrcState_StreamingSrcStateClosed */
+  StreamingSrcStateClosed = 0,
+  /* enum_StreamingSrcState_StreamingSrcStateOpening */
+  StreamingSrcStateOpening = 1,
+  /* enum_StreamingSrcState_StreamingSrcStateIdle */
+  StreamingSrcStateIdle = 2,
+  /* enum_StreamingSrcState_StreamingSrcStatePlaying */
+  StreamingSrcStatePlaying = 3,
+  /* enum_StreamingSrcState_StreamingSrcStateSeeking */
+  StreamingSrcStateSeeking = 4,
+  /* enum_StreamingSrcState_StreamingSrcStateEof */
+  StreamingSrcStateEof = 5,
+  /* enum_StreamingSrcState_StreamingSrcStateError */
+  StreamingSrcStateError = 6,
+}
+
+/* class_InputSeiData */
+export class InputSeiData {
+  /* class_InputSeiData_type */
+  type?: number;
+  /* class_InputSeiData_timestamp */
+  timestamp?: number;
+  /* class_InputSeiData_frame_index */
+  frame_index?: number;
+  /* class_InputSeiData_private_data */
+  private_data?: Uint8Array;
+  /* class_InputSeiData_data_size */
+  data_size?: number;
+}

package/ts/Private/IAgoraMusicContentCenter.ts

@@ -0,0 +1,455 @@
+import './extension/IAgoraMusicContentCenterExtension';
+import { IMediaPlayer } from './IAgoraMediaPlayer';
+
+/**
+ * @ignore
+ */
+export enum MusicPlayMode {
+  /**
+   * @ignore
+   */
+  KMusicPlayModeOriginal = 0,
+  /**
+   * @ignore
+   */
+  KMusicPlayModeAccompany = 1,
+  /**
+   * @ignore
+   */
+  KMusicPlayModeLeadSing = 2,
+}
+
+/**
+ * @ignore
+ */
+export enum PreloadState {
+  /**
+   * @ignore
+   */
+  KPreloadStateCompleted = 0,
+  /**
+   * @ignore
+   */
+  KPreloadStateFailed = 1,
+  /**
+   * @ignore
+   */
+  KPreloadStatePreloading = 2,
+  /**
+   * @ignore
+   */
+  KPreloadStateRemoved = 3,
+}
+
+/**
+ * @ignore
+ */
+export enum MusicContentCenterStateReason {
+  /**
+   * @ignore
+   */
+  KMusicContentCenterReasonOk = 0,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterReasonError = 1,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterReasonGateway = 2,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterReasonPermissionAndResource = 3,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterReasonInternalDataParse = 4,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterReasonMusicLoading = 5,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterReasonMusicDecryption = 6,
+  /**
+   * @ignore
+   */
+  KMusicContentCenterReasonHttpInternalError = 7,
+}
+
+/**
+ * @ignore
+ */
+export class MusicChartInfo {
+  /**
+   * @ignore
+   */
+  chartName?: string;
+  /**
+   * @ignore
+   */
+  id?: number;
+}
+
+/**
+ * @ignore
+ */
+export enum MusicCacheStatusType {
+  /**
+   * @ignore
+   */
+  MusicCacheStatusTypeCached = 0,
+  /**
+   * @ignore
+   */
+  MusicCacheStatusTypeCaching = 1,
+}
+
+/**
+ * @ignore
+ */
+export class MusicCacheInfo {
+  /**
+   * @ignore
+   */
+  songCode?: number;
+  /**
+   * @ignore
+   */
+  status?: MusicCacheStatusType;
+}
+
+/**
+ * @ignore
+ */
+export abstract class MusicChartCollection {
+  /**
+   * @ignore
+   */
+  abstract getCount(): number;
+
+  /**
+   * @ignore
+   */
+  abstract get(index: number): MusicChartInfo;
+}
+
+/**
+ * @ignore
+ */
+export class MvProperty {
+  /**
+   * @ignore
+   */
+  resolution?: string;
+  /**
+   * @ignore
+   */
+  bandwidth?: string;
+}
+
+/**
+ * The climax parts of the music.
+ */
+export class ClimaxSegment {
+  /**
+   * The time (ms) when the climax part begins.
+   */
+  startTimeMs?: number;
+  /**
+   * The time (ms) when the climax part ends.
+   */
+  endTimeMs?: number;
+}
+
+/**
+ * @ignore
+ */
+export class Music {
+  /**
+   * @ignore
+   */
+  songCode?: number;
+  /**
+   * @ignore
+   */
+  name?: string;
+  /**
+   * @ignore
+   */
+  singer?: string;
+  /**
+   * @ignore
+   */
+  poster?: string;
+  /**
+   * @ignore
+   */
+  releaseTime?: string;
+  /**
+   * @ignore
+   */
+  durationS?: number;
+  /**
+   * @ignore
+   */
+  type?: number;
+  /**
+   * @ignore
+   */
+  pitchType?: number;
+  /**
+   * @ignore
+   */
+  lyricCount?: number;
+  /**
+   * @ignore
+   */
+  lyricList?: number[];
+  /**
+   * @ignore
+   */
+  climaxSegmentCount?: number;
+  /**
+   * @ignore
+   */
+  climaxSegmentList?: ClimaxSegment[];
+  /**
+   * @ignore
+   */
+  mvPropertyCount?: number;
+  /**
+   * @ignore
+   */
+  mvPropertyList?: MvProperty[];
+}
+
+/**
+ * @ignore
+ */
+export abstract class MusicCollection {
+  /**
+   * @ignore
+   */
+  abstract getCount(): number;
+
+  /**
+   * @ignore
+   */
+  abstract getTotal(): number;
+
+  /**
+   * @ignore
+   */
+  abstract getPage(): number;
+
+  /**
+   * @ignore
+   */
+  abstract getPageSize(): number;
+
+  /**
+   * @ignore
+   */
+  abstract getMusic(index: number): Music;
+}
+
+/**
+ * @ignore
+ */
+export interface IMusicContentCenterEventHandler {
+  /**
+   * @ignore
+   */
+  onMusicChartsResult?(
+    requestId: string,
+    result: MusicChartInfo[],
+    reason: MusicContentCenterStateReason
+  ): void;
+
+  /**
+   * @ignore
+   */
+  onMusicCollectionResult?(
+    requestId: string,
+    result: MusicCollection,
+    reason: MusicContentCenterStateReason
+  ): void;
+
+  /**
+   * @ignore
+   */
+  onLyricResult?(
+    requestId: string,
+    songCode: number,
+    lyricUrl: string,
+    reason: MusicContentCenterStateReason
+  ): void;
+
+  /**
+   * @ignore
+   */
+  onSongSimpleInfoResult?(
+    requestId: string,
+    songCode: number,
+    simpleInfo: string,
+    reason: MusicContentCenterStateReason
+  ): void;
+
+  /**
+   * @ignore
+   */
+  onPreLoadEvent?(
+    requestId: string,
+    songCode: number,
+    percent: number,
+    lyricUrl: string,
+    state: PreloadState,
+    reason: MusicContentCenterStateReason
+  ): void;
+}
+
+/**
+ * @ignore
+ */
+export class MusicContentCenterConfiguration {
+  /**
+   * @ignore
+   */
+  appId?: string;
+  /**
+   * @ignore
+   */
+  token?: string;
+  /**
+   * @ignore
+   */
+  mccUid?: number;
+  /**
+   * @ignore
+   */
+  maxCacheSize?: number;
+  /**
+   * @ignore
+   */
+  mccDomain?: string;
+}
+
+/**
+ * @ignore
+ */
+export abstract class IMusicPlayer extends IMediaPlayer {
+  /**
+   * @ignore
+   */
+  abstract setPlayMode(mode: MusicPlayMode): number;
+
+  /**
+   * @ignore
+   */
+  abstract openWithSongCode(songCode: number, startPos?: number): number;
+}
+
+/**
+ * @ignore
+ */
+export abstract class IMusicContentCenter {
+  /**
+   * @ignore
+   */
+  abstract initialize(configuration: MusicContentCenterConfiguration): number;
+
+  /**
+   * @ignore
+   */
+  abstract renewToken(token: string): number;
+
+  /**
+   * @ignore
+   */
+  abstract release(): void;
+
+  /**
+   * @ignore
+   */
+  abstract registerEventHandler(
+    eventHandler: IMusicContentCenterEventHandler
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract unregisterEventHandler(): number;
+
+  /**
+   * @ignore
+   */
+  abstract createMusicPlayer(): IMusicPlayer;
+
+  /**
+   * @ignore
+   */
+  abstract destroyMusicPlayer(musicPlayer: IMusicPlayer): number;
+
+  /**
+   * @ignore
+   */
+  abstract getMusicCharts(): string;
+
+  /**
+   * @ignore
+   */
+  abstract getMusicCollectionByMusicChartId(
+    musicChartId: number,
+    page: number,
+    pageSize: number,
+    jsonOption?: string
+  ): string;
+
+  /**
+   * @ignore
+   */
+  abstract searchMusic(
+    keyWord: string,
+    page: number,
+    pageSize: number,
+    jsonOption?: string
+  ): string;
+
+  /**
+   * @ignore
+   */
+  abstract preload(songCode: number): string;
+
+  /**
+   * @ignore
+   */
+  abstract removeCache(songCode: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract getCaches(): { cacheInfo: MusicCacheInfo[]; cacheInfoSize: number };
+
+  /**
+   * @ignore
+   */
+  abstract isPreloaded(songCode: number): boolean;
+
+  /**
+   * @ignore
+   */
+  abstract getLyric(songCode: number, lyricType?: number): string;
+
+  /**
+   * @ignore
+   */
+  abstract getSongSimpleInfo(songCode: number): string;
+
+  /**
+   * @ignore
+   */
+  abstract getInternalSongCode(songCode: number, jsonOption: string): number;
+}