Version

    Other Documentation

menu_open
Wwise SDK 2019.1.11
AK::IAkAutoStream Class Referenceabstract

Public Member Functions

Stream management, settings access, and run-time change.
virtual void  Destroy ()=0
 
virtual void  GetInfo (AkStreamInfo &out_info)=0
 
virtual void *  GetFileDescriptor ()=0
 
virtual void  GetHeuristics (AkAutoStmHeuristics &out_heuristics)=0
 
virtual AKRESULT  SetHeuristics (const AkAutoStmHeuristics &in_heuristics)=0
 
virtual AKRESULT  SetMinimalBufferSize (AkUInt32 in_uMinBufferSize)=0
 
virtual AKRESULT  SetMinTargetBufferSize (AkUInt32 in_uMinTargetBufferSize)=0
 
virtual AKRESULT  SetStreamName (const AkOSChar *in_pszStreamName)=0
 
virtual AkUInt32  GetBlockSize ()=0
 
virtual AKRESULT  QueryBufferingStatus (AkUInt32 &out_uNumBytesAvailable)=0
 
virtual AkUInt32  GetNominalBuffering ()=0
 
Stream operations.
virtual AKRESULT  Start ()=0
 
virtual AKRESULT  Stop ()=0
 
virtual AkUInt64  GetPosition (bool *out_pbEndOfStream)=0
 
virtual AKRESULT  SetPosition (AkInt64 in_iMoveOffset, AkMoveMethod in_eMoveMethod, AkInt64 *out_piRealOffset)=0
 
Data/status access.
virtual AKRESULT  GetBuffer (void *&out_pBuffer, AkUInt32 &out_uSize, bool in_bWait)=0
 
virtual AKRESULT  ReleaseBuffer ()=0
 

Protected Member Functions

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

Detailed Description

Interface of automatic streams. It is used as a handle to a stream, I/O operations are triggered from here. Obtained through the Stream Manager's AK::IAkStreamMgr::CreateAuto() method.

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

Definition at line 483 of file IAkStreamMgr.h.


The documentation for this class was generated from the following file:

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