FAudioChunkHandle

This structure allows audio chunk data to be accessed, and guarantees that the chunk in question will not be deleted during it's lifecycle.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/ContentStreaming.h

Include

#include "ContentStreaming.h"

Syntax

class FAudioChunkHandle

Remarks

This structure allows audio chunk data to be accessed, and guarantees that the chunk in question will not be deleted during it's lifecycle.

Constructors

Name Description

Public function

FAudioChunkHandle()

Public function

FAudioChunkHandle

(
    const FAudioChunkHandle& Other
)

Public function

FAudioChunkHandle

(
    FAudioChunkHandle&& Other
)

Destructors

Name Description

Public function

~FAudioChunkHandle()

Functions

Name Description

Public function Const

const uint8 ...

 

GetData()

Gets a pointer to the compressed chunk.

Public function Const

bool

 

IsStale()

If the soundwave has been recompressed, the compressed audio retained by this handle will not be up to date, and this will return true.

Public function Const

bool

 

IsValid()

Checks whether this points to a valid compressed chunk.

Public function Const

uint32

 

Num()

Returns the num bytes pointed to by GetData().

Operators

Name Description

Public function

FAudioChunkH...

 

operator=

(
    const FAudioChunkHandle& Other
)

Public function

FAudioChunkH...

 

operator=

(
    FAudioChunkHandle&& Other
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss