IXStudioTitleClient Interface

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Represents an IXStudioTitleClient.

Syntax

interface IXStudioTitleClient : public IUnknown  

IXStudioTitleClient has the following members.

Public Methods

  Name Description
AddStream Adds a custom title stream.
BeginWriteEvent Begins to write an event.
GetNextEvent Gets the next available event from the custom title stream.
IsConsuming Indicates whether event data is flowing toward the consuming endpoint.
IsProducing Indicates whether event data is flowing from the producing endpoint.
RemoveStream Removes a custom title stream.
SetStreamBinaryMetaData Inserts a stream-level binary metadata tag (key:value pair). The metadata value is a opaque binary large object (BLOB).
SetStreamMetaData Inserts a stream-level metadata tag (key:value pair).
WriteEvent Writes an event - syncronously - to the custom title stream.

Requirements

Header: Declared in xstudio.h.

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