FMediaIOCorePlayerBase::SetRate

Set the current playback rate.

Windows
MacOS
Linux

Override Hierarchy

IMediaControls::SetRate()

FMediaIOCorePlayerBase::SetRate()

References

Module

MediaIOCore

Header

/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Public/MediaIOCorePlayerBase.h

Include

#include "MediaIOCorePlayerBase.h"

Source

/Engine/Plugins/Media/MediaIOFramework/Source/MediaIOCore/Private/Player/MediaIOCorePlayerBase.cpp

Syntax

virtual bool SetRate
(
    float Rate
)

Remarks

Set the current playback rate.

A playback rate of 1.0 will play the media normally at real-time. A rate of 0.0 corresponds to pausing playback. A negative rate, if supported, plays the media in reverse, and a rate larger than 1.0 fast forwards playback.

Returns

true on success, false otherwise.

Parameters

Parameter

Description

Rate

The playback rate to set.

See Also

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