isobmff-inspector
Version:
Simple ISOBMFF parser, compatible with JavaScript and Node.JS
57 lines • 2.29 kB
TypeScript
/**
* Progressively parse ISOBMFF data and yield metadata events as boxes are found.
* @param {import("../types.js").ISOBMFFInput} input
* @param {import("../types.js").ParseEventsOptions=} options
* @returns {AsyncGenerator<import("../types.js").ParsedBoxParseEvent, void, void>}
*/
export function parseEvents(input: import("../types.js").ISOBMFFInput, options?: import("../types.js").ParseEventsOptions | undefined): AsyncGenerator<import("../types.js").ParsedBoxParseEvent, void, void>;
/**
* @overload
* @param {import("../types.js").ISOBMFFInput} arr
* @returns {Promise<import("../types.js").ParsedBox[]>}
*/
export function parse(arr: import("../types.js").ISOBMFFInput): Promise<import("../types.js").ParsedBox[]>;
/**
* @overload
* @param {import("../types.js").ISOBMFFInput} arr
* @param {{ format?: "full" }} options
* @returns {Promise<import("../types.js").ParsedBox[]>}
*/
export function parse(arr: import("../types.js").ISOBMFFInput, options: {
format?: "full";
}): Promise<import("../types.js").ParsedBox[]>;
/**
* @overload
* @param {import("../types.js").ISOBMFFInput} arr
* @param {{ format: "simple" }} options
* @returns {Promise<import("../types.js").SimpleParsedBox[]>}
*/
export function parse(arr: import("../types.js").ISOBMFFInput, options: {
format: "simple";
}): Promise<import("../types.js").SimpleParsedBox[]>;
/**
* @overload
* @param {import("../types.js").ISOBMFFByteChunk} arr
* @returns {import("../types.js").ParsedBox[]}
*/
export function parseBuffer(arr: import("../types.js").ISOBMFFByteChunk): import("../types.js").ParsedBox[];
/**
* @overload
* @param {import("../types.js").ISOBMFFByteChunk} arr
* @param {{ format?: "full" }} options
* @returns {import("../types.js").ParsedBox[]}
*/
export function parseBuffer(arr: import("../types.js").ISOBMFFByteChunk, options: {
format?: "full";
}): import("../types.js").ParsedBox[];
/**
* @overload
* @param {import("../types.js").ISOBMFFByteChunk} arr
* @param {{ format: "simple" }} options
* @returns {import("../types.js").SimpleParsedBox[]}
*/
export function parseBuffer(arr: import("../types.js").ISOBMFFByteChunk, options: {
format: "simple";
}): import("../types.js").SimpleParsedBox[];
export default parse;
//# sourceMappingURL=index.d.ts.map