Skip to content

Latest commit

 

History

History
351 lines (201 loc) · 7.92 KB

AsfFilePropertiesObject.md

File metadata and controls

351 lines (201 loc) · 7.92 KB

node-taglib-sharp / Exports / AsfFilePropertiesObject

Class: AsfFilePropertiesObject

Extends BaseObject to provide a representation of an ASF file properties object. The file properties object defines the global characteristics of the combined digital media streams found within the Data object.

Hierarchy

Table of contents

Accessors

Methods

Accessors

creationDate

get creationDate(): Date

Gets the creation date of the file described by the current instance.

Returns

Date


dataPacketsCount

get dataPacketsCount(): bigint

Gets the number of packets in the data section of the file represented by the current instance.

Returns

bigint


fileId

get fileId(): UuidWrapper

Gets the GUID for the file described by the current instance.

Returns

UuidWrapper


fileSize

get fileSize(): bigint

Gets the total size of the file described by the current instance in bytes.

Returns

bigint


flags

get flags(): number

Gets whether the file described by the current instance is broadcast or seekable.

Remarks

This attribute applies to presentation descriptors for ASF content. The value is a bitwise OR of the flags in FilePropertiesFlags. * If FilePropertiesFlags.Broadcast is set, the following properties are not valid * fileId * creationDate * dataPacketsCount * playDurationMilliseconds * sendDurationMilliseconds * maximumDataPacketSize and minimumDataPacketSize are set to the actual packet size * If FilePropertiesFlags.Seekable is set, an audio stream is present and the maximumDataPacketSize and minimumDataPacketSize are set to the same size. It can also be seekable if the file has an audio stream and a video stream with a matching simple index object.

Returns

number


guid

get guid(): UuidWrapper

Gets the GUID that identifies the current instance.

Returns

UuidWrapper

Inherited from

BaseObject.guid


maximumBitrate

get maximumBitrate(): number

Gets the maximum instantaneous bit rate, in bits per second, for the file described by the current instance.

Returns

number


maximumDataPacketSize

get maximumDataPacketSize(): number

Gets the maximum packet size, in bytes, for the file described by the current instance.

Returns

number


minimumDataPacketSize

get minimumDataPacketSize(): number

Gets the minimum packet size, in bytes, for the file described by the current instance.

Returns

number


objectType

get objectType(): AsfObjectType

Gets the type of the object for easy comparison.

Returns

AsfObjectType

Overrides

BaseObject.objectType


originalSize

get originalSize(): number

Gets the original size of the current instance.

Returns

number

Inherited from

BaseObject.originalSize


playDurationMilliseconds

get playDurationMilliseconds(): number

Get the time needed to play the file described by the current instance in milliseconds.

Returns

number


prerollMilliseconds

get prerollMilliseconds(): number

Gets the amount of time, in milliseconds, to buffer data before playing the file described by the current instance.

Returns

number


sendDurationMilliseconds

get sendDurationMilliseconds(): number

Get the time needed to send the file described by the current instance in milliseconds. A packet's "send time" is the time when the packet should be delivered over the network, it is not the presentation of the packet.

Returns

number

Methods

initializeFromFile

Protected initializeFromFile(file, position): void

Initializes a new instance by reading the contents from a specified position in a specified file.

Parameters

Name Type Description
file File File which contains the details of the new instance to create
position number Position in file where the object begins

Returns

void

Inherited from

AsfBaseObject.initializeFromFile


initializeFromGuid

Protected initializeFromGuid(guid): void

Initializes a new instance with a specified GUID.

Parameters

Name Type Description
guid UuidWrapper GUID to use for the new instance.

Returns

void

Inherited from

AsfBaseObject.initializeFromGuid


render

render(): ByteVector

Renders the current instance as a raw ASF object.

Returns

ByteVector

Overrides

AsfBaseObject.render


renderInternal

Protected renderInternal(data): ByteVector

Renders the current instance as a raw ASF object containing the specified data.

Remarks

Child classes implementing () should render their contents and then send the data through this method to produce the final output.

Parameters

Name Type Description
data ByteVector Data to store in the rendered version of the current instance.

Returns

ByteVector

Inherited from

AsfBaseObject.renderInternal


fromFile

Static fromFile(file, position): AsfFilePropertiesObject

Constructs a new instance by reading from a file.

Parameters

Name Type Description
file File File to read the file properties object from
position number Offset into the file where the object begins

Returns

AsfFilePropertiesObject