IXStudioTitleClient::BeginWriteEvent Method

Important The XStudio native C nano-COM APIs have been deprecated in favor of the KStudio native C nano-COM APIs.
Begins to write an event.

Syntax

public:
HRESULT BeginWriteEvent(
         const GUID &streamType,
         UINT64 tick,
         const void *pIndexBlob,
         UINT32 indexBlobSize,
         const XStudioBufferAndSizeConst *pData,
         UINT32 dataCount,
         IXStudioAsyncResult **ppAsyncResult
)  

Parameters

streamType
Type: GUID 

[in] GUID identifying the title stream type.

tick
Type: UINT64 

[in] Time-index of the event to write.

pIndexBlob
Type: void *

A pointer to the IndexBlob.

indexBlobSize
Type: UINT32 

[in] The size of the IndexBlob.

pData
Type: XStudioBufferAndSizeConst *

A pointer to an array of XStudioBufferAndSizeConst elements.

dataCount
Type: UINT32 

[in] The number of XStudioBufferAndSizeConst elements.

ppAsyncResult
Type: IXStudioAsyncResult **

[out] A pointer to the IXStudioAsyncResult asynchronous write-completion result.

Return value

Type: HRESULT 

S_OK if successful; an error code otherwise.

Requirements

Header: Declared in xstudio.h.

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