Version

menu_open
Wwise SDK 2023.1.2
AK::IAkStdStream Class Referenceabstract

#include <IAkStreamMgr.h>

Public Member Functions

Stream management and settings.
virtual void Destroy ()=0
 
virtual void GetInfo (AkStreamInfo &out_info)=0
 
virtual void * GetFileDescriptor ()=0
 
virtual AKRESULT SetStreamName (const AkOSChar *in_pszStreamName)=0
 
virtual AkUInt32 GetBlockSize ()=0
 
I/O operations.
virtual AKRESULT Read (void *in_pBuffer, AkUInt32 in_uReqSize, bool in_bWait, AkPriority in_priority, AkReal32 in_fDeadline, AkUInt32 &out_uSize)=0
 
virtual AKRESULT Write (void *in_pBuffer, AkUInt32 in_uReqSize, bool in_bWait, AkPriority in_priority, AkReal32 in_fDeadline, AkUInt32 &out_uSize)=0
 
virtual AkUInt64 GetPosition (bool *out_pbEndOfStream)=0
 
virtual AKRESULT SetPosition (AkInt64 in_iMoveOffset, AkMoveMethod in_eMoveMethod)=0
 
virtual void Cancel ()=0
 
Access to data and status.
virtual void * GetData (AkUInt32 &out_uSize)=0
 
virtual AkStmStatus GetStatus ()=0
 
virtual AkStmStatus WaitForPendingOperation ()=0
 

Protected Member Functions

virtual ~IAkStdStream ()
 Virtual destructor on interface to avoid warnings. More...
 

Detailed Description

Interface of standard streams. Used as a handle to a standard stream. Has methods for stream control. Obtained through the Stream Manager's AK::IAkStreamMgr::CreateStd() method.

Warning: The functions in this interface are not thread-safe, unless stated otherwise.

Definition at line 420 of file IAkStreamMgr.h.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise