Function HlsSegmentApiAxiosParamCreator

HlsSegmentApi - axios parameter creator

Export

  • HlsSegmentApiAxiosParamCreator(configuration?): {
        getHlsAudioSegmentLegacyAac: ((itemId: string, segmentId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getHlsAudioSegmentLegacyMp3: ((itemId: string, segmentId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getHlsPlaylistLegacy: ((itemId: string, playlistId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getHlsVideoSegmentLegacy: ((itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        stopEncodingProcess: ((deviceId: string, playSessionId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        getHlsAudioSegmentLegacyAac: ((itemId: string, segmentId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getHlsAudioSegmentLegacyMp3: ((itemId: string, segmentId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getHlsPlaylistLegacy: ((itemId: string, playlistId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getHlsVideoSegmentLegacy: ((itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        stopEncodingProcess: ((deviceId: string, playSessionId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • getHlsAudioSegmentLegacyAac: ((itemId: string, segmentId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets the specified audio segment for an audio item.

      Throws

        • (itemId, segmentId, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            The item id.

          • segmentId: string

            The segment id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getHlsAudioSegmentLegacyMp3: ((itemId: string, segmentId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets the specified audio segment for an audio item.

      Throws

        • (itemId, segmentId, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            The item id.

          • segmentId: string

            The segment id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getHlsPlaylistLegacy: ((itemId: string, playlistId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a hls video playlist.

      Throws

        • (itemId, playlistId, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            The video id.

          • playlistId: string

            The playlist id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getHlsVideoSegmentLegacy: ((itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a hls video segment.

      Throws

        • (itemId, playlistId, segmentId, segmentContainer, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • stopEncodingProcess: ((deviceId: string, playSessionId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Stops an active encoding.

      Throws

        • (deviceId, playSessionId, options?): Promise<RequestArgs>

        • 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<RequestArgs>

Settings

Member Visibility