isobmff-inspector
Version:
Simple ISOBMFF parser, compatible with JavaScript and Node.JS
84 lines • 3.12 kB
TypeScript
/**
* @param {number} raw
* @param {number} totalBits
* @param {import("./types.js").ParsedBitsFieldPartDefinition[]} parts
* @returns {import("./types.js").ParsedBitsField}
*/
export function bitsField(raw: number, totalBits: number, parts: import("./types.js").ParsedBitsFieldPartDefinition[]): import("./types.js").ParsedBitsField;
/**
* @param {Uint8Array} value
* @param {number} offset
* @param {number} nbBytes
* @returns {import("./types.js").ParsedBytesField}
*/
export function bytesField(value: Uint8Array, offset: number, nbBytes: number): import("./types.js").ParsedBytesField;
/**
* @param {number} value
* @param {number} fractionalBits
* @returns {number}
*/
export function decodeFixedPoint(value: number, fractionalBits: number): number;
/**
* @param {number} value
* @param {number} bits
* @param {number} fractionalBits
* @returns {number}
*/
export function decodeSignedFixedPoint(value: number, bits: number, fractionalBits: number): number;
/**
* @param {number} raw
* @param {number} bits
* @param {number} fractionalBits
* @param {string} format
* @returns {import("./types.js").ParsedFixedPointField}
*/
export function fixedPointField(raw: number, bits: number, fractionalBits: number, format: string): import("./types.js").ParsedFixedPointField;
/**
* @param {number} raw
* @param {number} totalBits
* @param {Record<string, number>} flags
* @returns {import("./types.js").ParsedFlagsField}
*/
export function flagsField(raw: number, totalBits: number, flags: Record<string, number>): import("./types.js").ParsedFlagsField;
/**
* @param {number | bigint} value
* @returns {import("./types.js").ParsedDateField}
*/
export function macDateField(value: number | bigint): import("./types.js").ParsedDateField;
/**
* @param {unknown} value
* @returns {import("./types.js").ParsedField}
*/
export function normalizeField(value: unknown): import("./types.js").ParsedField;
/**
* @param {string} key
* @param {unknown} value
* @param {string | { description?: string, offset?: number, byteLength?: number }=} meta
* @returns {import("./types.js").ParsedBoxValue}
*/
export function parsedBoxValue(key: string, value: unknown, meta?: (string | {
description?: string;
offset?: number;
byteLength?: number;
}) | undefined): import("./types.js").ParsedBoxValue;
/**
* @param {number} raw
* @param {number} bits
* @param {number} fractionalBits
* @param {string} format
* @returns {import("./types.js").ParsedFixedPointField}
*/
export function signedFixedPointField(raw: number, bits: number, fractionalBits: number, format: string): import("./types.js").ParsedFixedPointField;
/**
* @param {import("./types.js").ParsedBoxValue[]} fields
* @param {string=} layout
* @returns {import("./types.js").ParsedStructField}
*/
export function structField(fields: import("./types.js").ParsedBoxValue[], layout?: string | undefined): import("./types.js").ParsedStructField;
/**
* @param {number} value
* @param {number} bits
* @returns {number}
*/
export function toSignedInt(value: number, bits: number): number;
//# sourceMappingURL=fields.d.ts.map