OggPackage class

OggPackage class

Represents a native metadata package in a OGG audio file.

Inheritance: OggPackage → CustomPackage → MetadataPackage

The OggPackage type exposes the following members:

Constructors

Constructor Description
__init__(self) Initializes a new instance of the OggPackage class.

Properties

Property Description
metadata_type Gets the metadata type.
keys Gets a collection of the metadata property names.
property_descriptors Gets a collection of descriptors that contain information about properties accessible through the GroupDocs.Metadata search engine.
count Gets the number of metadata properties.
vendor Vendor
title Track/Work name
version The version field may be used to differentiate multiple versions of the same track title in a single collection. (e.g. remix info)
album The collection name to which this track belongs
tracknumber The track number of this piece if part of a specific larger collection or album
artist The artist generally considered responsible for the work. In popular music this is usually the performing band or singer. For classical music it would be the composer. For an audio book it would be the author of the original text.
performer The artist(s) who performed the work. In classical music this would be the conductor, orchestra, soloists. In an audio book it would be the actor who did the reading. In popular music this is typically the same as the ARTIST and is omitted.
copyright Copyright attribution, e.g., ‘2001 Nobody’s Band’ or ‘1999 Jack Moffitt’
license License information, for example, ‘All Rights Reserved’, ‘Any Use Permitted’, a URL to a license such as a Creative Commons license (e.g. “creativecommons.org/licenses/by/4.0/”), or similar.
organization Name of the organization producing the track (i.e. the ‘record label’)
description A short text description of the contents
genre A short text indication of music genre
date Date the track was recorded
location Location where track was recorded
contact Contact information for the creators or distributors of the track. This could be a URL, an email address, the physical address of the producing label.
isrc ISRC number for the track
ogg_user_comments Gets an array of OggUserComment entries inside the metadata.

Methods

Method Description
contains(self, property_name) Determines whether the package contains a metadata property with the specified name.
find_properties(self, specification) Finds the metadata properties satisfying a specification.
The search is recursive so it affects all nested packages as well.
update_properties(self, specification, value) Updates known metadata properties satisfying a specification.
The operation is recursive so it affects all nested packages as well.
remove_properties(self, specification) Removes metadata properties satisfying a specification.
add_properties(self, specification, value) Adds known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
set_properties(self, specification, value) Sets known metadata properties satisfying the specification.
The operation is recursive so it affects all nested packages as well.
This method is a combination of MetadataPackage.add_properties and MetadataPackage.update_properties.
If an existing property satisfies the specification its value is updated.
If there is a known property missing in the package that satisfies the specification it is added to the package.
sanitize(self) Removes writable metadata properties from the package.
The operation is recursive so it affects all nested packages as well.

Remarks

Learn more | | |

Example

This code sample shows how to extract technical audio information from a OGG file.

See Also

OggRootPackage class