BassWmaBASS_WMA_EncodeSetTag Method (Int32, String, IntPtr, Int32)

public static bool BASS_WMA_EncodeSetTag(
	int handle,
	string tag,
	IntPtr value,
	int length
)

Public Shared Function BASS_WMA_EncodeSetTag ( 
	handle As Integer,
	tag As String,
	value As IntPtr,
	length As Integer
) As Boolean

Parameters

handle

Type: SystemInt32
The encoder handle.

tag

Type: SystemString
The tag to set (e.g. "WM/Picture").

value

Type: SystemIntPtr
The pointer to the binary tag's data.

length

Type: SystemInt32
The number of bytes provided as binary data in the tag.

Return Value

Header tags must be set before encoding any data - no more header tags can be set once BASS_WMA_EncodeWrite(Int32, IntPtr, Int32) has been called.

To set tags mid-stream (after encoding has begun), the BASS_WMA_ENCODE_SCRIPT flag needs to have been specified in the encoder's creation. A mid-stream tag typically used is "Caption", which get's displayed in Windows Media Player 9 and above (if the user has enabled captions).

When using a network encoder, it should be noted that while all header tags are sent to newly connecting clients, prior mid-stream tags are not. So if, for example, you're using the "Caption" tag to indicate the current song title, it should be sent at fairly regular intervals (not only at the start of the song).

On the playback side, mid-stream tags can be processed using BASS_ChannelSetSync(Int32, BASSSync, Int64, SYNCPROC, IntPtr) (with BASS_SYNC_META).

Reference