IXStudioRecording::SetStreamMetaData Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Inserts a stream-level string metadata tag (key:value pair).

Syntax

public:
HRESULT SetStreamMetaData(
         const GUID &streamType,
         UINT16 flags,
         const wchar_t *key,
         const wchar_t *value
)  

Parameters

streamType
Type: GUID 

[in] GUID identifying the title stream type.

flags
Type: UINT16 

[in] One or more XSTUDIO_FILE flags, indicating properties of the metadata.

key
Type: wchar_t *

[in] Null-terminated string that identifies the metadata.

value
Type: wchar_t *

[in] Null-terminated string that contains the metadata.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Remarks

Accessing stream-level metadata before the recording has been successfully started will fail.

Requirements

Header: Declared in xstudio.h.

Library: Use xstudioclient.lib (console) or xstudioservice.lib (desktop).