@dolbyio/dolbyio-rest-apis-client/dist/streaming/recordFiles.d.ts

Node.JS wrapper for the Dolby.io REST APIs

import { MediaAsset } from './types/recordFiles';
/**
 * Gets current total bytes of recorded files in storage.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/recordfilesv2_readrecordmediaasset
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param mediaAssetId Identifier of the media asset to read.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives the number of bytes used by the recorded files.
 */
export declare const readMediaAsset: (apiSecret: string, mediaAssetId: string) => Promise<MediaAsset>;
/**
 * Deletes multiple media assets from storage.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/recordfilesv2_deleterecordmediaassets
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param assetIds List of the media assets identifiers to delete from storage.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a flag indicating if the operation has succeeded.
 */
export declare const deleteMediaAssets: (apiSecret: string, assetIds: number[]) => Promise<boolean>;
/**
 * Deletes all recorded file from storage.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/recordfiles_deleteallrecordfiles
 *
 * @param apiSecret The API Secret used to authenticate this request.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives a flag indicating if the operation has succeeded.
 */
export declare const deleteAllFiles: (apiSecret: string) => Promise<boolean>;
/**
 * Gets current total bytes of recorded files in storage.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/recordfiles_recordfileusage
 *
 * @param apiSecret The API Secret used to authenticate this request.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives the number of bytes used by the recorded files.
 */
export declare const usage: (apiSecret: string) => Promise<number>;
/**
 * Gets total number of gigabyte hours of storage used within date range.
 *
 * @link https://docs.dolby.io/streaming-apis/reference/recordfiles_recordfileusagebillable
 *
 * @param apiSecret The API Secret used to authenticate this request.
 * @param startDate Start date from which to pull the recorded files usage.
 * @param stopDate End date from which to pull the recorded files usage.
 *
 * @returns A {@link !Promise Promise} whose fulfillment handler receives the number of gigabyte hours used by the recorded files. Measured as binary gigabytes (1024^3) per hour.
 */
export declare const usageBillable: (apiSecret: string, startDate: string, stopDate: string) => Promise<number>;