Function HlsSegmentApiFp

Returns {
    getHlsAudioSegmentLegacyAac(itemId: string, segmentId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getHlsAudioSegmentLegacyMp3(itemId: string, segmentId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getHlsPlaylistLegacy(itemId: string, playlistId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    getHlsVideoSegmentLegacy(itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>;
    stopEncodingProcess(deviceId: string, playSessionId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}

• getHlsAudioSegmentLegacyAac:function

  • getHlsAudioSegmentLegacyAac(itemId, segmentId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

  • Parameters

    • itemId: string

      The item id.
    • segmentId: string

      The segment id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

    Summary

    Gets the specified audio segment for an audio item.

    Throws

• getHlsAudioSegmentLegacyMp3:function

  • getHlsAudioSegmentLegacyMp3(itemId, segmentId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

  • Parameters

    • itemId: string

      The item id.
    • segmentId: string

      The segment id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

    Summary

    Gets the specified audio segment for an audio item.

    Throws

• getHlsPlaylistLegacy:function

  • getHlsPlaylistLegacy(itemId, playlistId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

  • Parameters

    • itemId: string

      The video id.
    • playlistId: string

      The playlist id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

    Summary

    Gets a hls video playlist.

    Throws

• getHlsVideoSegmentLegacy:function

  • getHlsVideoSegmentLegacy(itemId, playlistId, segmentId, segmentContainer, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

  • Parameters

    • itemId: string

      The item id.
    • playlistId: string

      The playlist id.
    • segmentId: string

      The segment id.
    • segmentContainer: string

      The segment container.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>)>

    Summary

    Gets a hls video segment.

    Throws

• stopEncodingProcess:function

  • stopEncodingProcess(deviceId, playSessionId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • deviceId: string

      The device id of the client requesting. Used to stop encoding processes when needed.
    • playSessionId: string

      The play session id.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Stops an active encoding.

    Throws