BASS.NET API for the Un4seen BASS Audio Library

BassBASS_ChannelGetTagsArrayNullTermUtf8 Method

BASS.NET API for the Un4seen BASS Audio Library
Retrieves the header tags from a channel, if they are available.

NOTE: This method evaluates the header as a series/array of null-terminated UTF-8 strings.

Might be used e.g. with: APE, MP4, OGG and WMA - if UTF-8!

Namespace:  Un4seen.Bass
Assembly:  Bass.Net (in Bass.Net.dll) Version: 2.4.17.5
Syntax

public static string[] BASS_ChannelGetTagsArrayNullTermUtf8(
	int handle,
	BASSTag format
)

Parameters

handle
Type: SystemInt32
The channel handle...a HMUSIC or HSTREAM.
format
Type: Un4seen.BassBASSTag
The type of tags/headers wanted... one of the following (see BASSTag):
BASS_TAG_OGGOGG tags, only available when streaming an OGG file. A pointer to a series of null-terminated UTF-8 strings is returned, the final string ending with a double null.
BASS_TAG_VENDORVendor encoder tag. A single UTF-8 string is returned.
BASS_TAG_WMAWMA tags : array of null-terminated UTF-8 strings.
BASS_TAG_WMA_METAWMA mid-stream tag : A single UTF-8 string is returned.
BASS_TAG_WMA_CODECWMA codec tag : Two UTF-8 strings are returned.
BASS_TAG_APEAPE tags. A pointer to a series of null-terminated UTF-8 strings is returned, the final string ending with a double null. Each string is in the form of "key=value", or "key=value1/value2/..." if there are multiple values.
BASS_TAG_MP4MP4 tags. A pointer to a series of null-terminated UTF-8 strings is returned, the final string ending with a double null.
BASS_TAG_MFMedia Foundation metadata. A pointer to a series of null-terminated UTF-8 strings is returned, the final string ending with a double null.
Other tags may be supported by Add-Ons, see the documentation - only UTF-8!

Return Value

Type: String
or an array of strings. Each array element will represent one tag, e.g. "TITLE=this is a title"
Remarks

Only available when streaming a file containing tags/headers which are defined as a series of null-terminated UNICODE strings! So make sure to use this method only with appropriate formats!

In addition you might also use the BassTags class, which provides extended TAG reading support.

ERROR CODEDescription
BASS_ERROR_HANDLEhandle is not valid.
BASS_ERROR_NOTAVAILThe requested tags are not available.

See Also

Reference