Skip to content

Commit

Permalink
feat: export MP4 parser (#189)
Browse files Browse the repository at this point in the history
* feat: export MP4 parser

* chore(type): change to MP4Parser
  • Loading branch information
dominique-pfister authored Dec 12, 2023
1 parent d81a16e commit 6106013
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@
* governing permissions and limitations under the License.
*/
export * from './MediaHandler';
export * from './mp4/Parser';
3 changes: 2 additions & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@
* governing permissions and limitations under the License.
*/
import MediaHandler from './MediaHandler.js';
import { Parser as MP4Parser } from './mp4/Parser.js';

export {
// eslint-disable-next-line import/prefer-default-export
MediaHandler,
MP4Parser,
};
58 changes: 58 additions & 0 deletions src/mp4/Parser.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* Copyright 2021 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/

/**
* Default Resource Meta
*/
export declare interface MP4Info {
/**
* Width
*/
width: number;

/**
* Height
*/
height: number;

/**
* Duration in seconds
*/
duration?: number;
}

/**
* MP4 parser that will return information about width, height and duration.
*/
export declare class MP4Parser {
/**
* Creates a new MP4 parser
*
* @param {Buffer} buf buffer
* @param {any} log logger
* @param {name} name of MP4 being parsed
* @throws Error If the options are invalid.
*/
constructor(buf: Buffer, log: any, name?: string);

/**
* Probe the buffer whether it is a valid MP4
*
* @returns true if the MP4 is valid, false otherwise
*/
probe(): boolean;

/**
* Parse the buffer and return information
*/
parse(): MP4Info;
}

0 comments on commit 6106013

Please sign in to comment.