FMovieSceneChannelHandle

Handle to a specific channel in a [UMovieSceneSection](API\Runtime\MovieScene\UMovieSceneSection).

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelHandle.h

Include

#include "Channels/MovieSceneChannelHandle.h"

Syntax

struct FMovieSceneChannelHandle

Remarks

Handle to a specific channel in a UMovieSceneSection. Will become nullptr when the FMovieSceneChannelProxy it was created with is reallocated.

Constructors

Name Description

Public function

FMovieSceneChannelHandle()

Default constructor

Public function

FMovieSceneChannelHandle

(
    TWeakPtr< FMovieSceneChannelProxy >...,
    FName InChannelTypeName,
    int32 InChannelIndex
)

Construction from a weak channel proxy, the channel's type, and its index

Functions

Name Description

Public function Const

TMovieSceneC...

 

Cast()

Cast this handle to a handle of a related type.

Public function Const

FMovieSceneC...

 

Get()

Get the channel pointer this handle represents.

Public function Const

int32

 

GetChannelIndex()

Access this channel's index

Public function Const

FMovieSceneC...

 

GetChannelProxy()

Attempt to access the proxy for this channel. Will return nullptr if it is no longer valid.

Public function Const

FName

 

GetChannelTypeName()

Access this channel's type identifier

Public function Const

const void &...

 

GetExtendedEditorData()

Get the extended editor data associated with this channel

Public function Const

const FMovie...

 

GetMetaData()

Get the meta data associated with this channel

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