Class StreamingPlayer

ストリーミングプレイヤー

概要

映像のストリーミング再生を行うプレイヤーです。

必要な権限:

  • ライブ + 録画(VOD配信の場合)

必要なOAuth2.0 scope:

  • safie-api もしくは api:device:live:view + api:device:timeline:view

Hierarchy

  • StreamingPlayer

Constructors

  • Parameters

    • element: HTMLElement

      プレイヤーを配置するルートの要素

    • Optional config: PlayerConfig

      初期化時のコンフィグ

    Returns StreamingPlayer

    Example

    const element = document.getElementById('player');
    const player = new Safie.Player.StreamingPlayer(element, {
    volume: 50
    });

Accessors

  • get deviceId(): string
  • 設定されているデバイスのデバイスIDを返します。

    Returns string

  • set deviceId(value): void
  • デバイスを設定します。再生中のストリーミング再生は停止します。

    Parameters

    • value: string

      デバイスID

    Returns void

  • get volume(): number
  • 音量の設定値を返します。

    Returns number

  • set volume(value): void
  • 音量を設定します。

    Parameters

    • value: number

      音量値 (0 - 100)

    Returns void

  • get muted(): boolean
  • ミュートの設定値を返します。

    Returns boolean

  • set muted(value): void
  • ミュートの有効/無効を設定します。本設定が有効の時はvolumeよりも優先されます。

    Parameters

    • value: boolean

      有効/無効

    Returns void

  • get userInteractions(): boolean
  • 設定値を返します。

    Returns boolean

  • set userInteractions(value): void
  • マウス・タッチ操作によるズーム操作および再生/一時停止を有効/無効にします

    Parameters

    • value: boolean

      有効/無効

    Returns void

  • get playTime(): number
  • 現在の再生時刻を返します。

    Returns number

Methods

  • ストリーミング再生を開始します。

    Parameters

    • timestamp: number = null

      再生時刻 (UNIX時間ミリ秒)。未指定の場合はLIVE配信になります。

    • playbackRate: number = 1

      再生速度の倍率(0.25, 0.5, 1, 3, 10, 30)。LIVE配信の場合は強制的に1になります。

    Returns void

    Description

    timestampを指定した時、値が現在時刻から以下の秒数以内の場合、強制的にLIVE配信になります。

    playbackRate 秒数
    1以下 60
    3 66
    10 80
    30 120
  • ストリーミング再生を停止します。

    Returns void

  • ストリーミング再生を一時停止します。

    Returns void

    Description

    PlayerStatusがerrorの時は無視されます。

  • ストリーミング再生の一時停止を再開します。

    Returns void

    Description

    PlayerStatusがerrorの時は無視されます。

  • プレイヤーイベントのイベントハンドラーを登録します。

    Type Parameters

    Parameters

    Returns void

    Example

    function onTimeChange(timestamp) {
    console.log(timestamp);
    }

    player.on('playTimeChange', onTimeChange);
  • プレイヤーイベントのイベントハンドラーを解除します。

    Type Parameters

    Parameters

    Returns void

    Example

    //特定のイベントハンドラーを解除
    player.off('playTimeChange', onTimeChange);
    //すべてのイベントハンドラーを解除
    player.off('playTimeChange');
  • プレイヤーのインスタンスを破棄します。

    Returns void

    Description

    プレイヤーを削除する時に呼び出す必要があります。実行後にインスタンスを再利用することはできません。

    Example

    //インスタンスの破棄
    player.dispose();
    // 要素の破棄
    playerElem.remove();

    //インスタンスの再利用は不可
    player.play(); //error