Navigation
API > API/Plugins > API/Plugins/MediaStream
Interface for Media Stream Players. Should only be used within a Media Stream object.
| Name | IMediaStreamPlayer |
| Type | class |
| Header File | /Engine/Plugins/Experimental/MediaStream/Source/MediaStream/Public/IMediaStreamPlayer.h |
| Include Path | #include "IMediaStreamPlayer.h" |
Syntax
class IMediaStreamPlayer
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyPlayerConfig() |
Applies the current player config to the current media player. This is generally automatic. | IMediaStreamPlayer.h |
|
void ApplyTextureConfig() |
Applies the current texture config to the current media texture. This is generally automatic. | IMediaStreamPlayer.h |
|
bool Close() |
Closes the current media player. | IMediaStreamPlayer.h |
|
void Deinitialize() |
Called by the Media Stream when it is done with this Media Stream Player. | IMediaStreamPlayer.h | |
bool FastForward() |
Seeks to the end of the current media. | IMediaStreamPlayer.h |
|
UMediaStream * GetMediaStream() |
IMediaStreamPlayer.h |
|
|
UMediaTexture * GetMediaTexture() |
IMediaStreamPlayer.h |
|
|
EMediaStreamPlaybackState GetPlaybackState() |
IMediaStreamPlayer.h |
|
|
UMediaPlayer * GetPlayer() |
IMediaStreamPlayer.h |
|
|
const FMediaStreamPlayerConfig & GetPlayerConfig() |
IMediaStreamPlayer.h |
|
|
int32 GetPlaylistIndex() |
IMediaStreamPlayer.h |
|
|
int32 GetPlaylistNum() |
IMediaStreamPlayer.h |
|
|
int32 GetRequestedSeekFrame() |
IMediaStreamPlayer.h |
|
|
float GetRequestedSeekTime() |
IMediaStreamPlayer.h |
|
|
UMediaStream * GetSourceStream() |
IMediaStreamPlayer.h |
|
|
const FMediaStreamTextureConfig & GetTextureConfig() |
IMediaStreamPlayer.h |
|
|
bool HasValidPlayer() |
IMediaStreamPlayer.h |
|
|
bool IsReadOnly() |
Returns whether this player's controls can do anything. | IMediaStreamPlayer.h |
|
bool Next() |
Goes to the next item in the playlist. Only possible with playlist sources. | IMediaStreamPlayer.h |
|
void OnCreated() |
IMediaStreamPlayer.h |
|
|
void OnSourceChanged
(
const FMediaStreamSource& InSource |
Called by the owning Media Stream when the source changes so that the player can update. | IMediaStreamPlayer.h | |
bool OpenSource() |
Opens the source if it is not already opened. | IMediaStreamPlayer.h |
|
bool Pause() |
Pauses playback of the current media. | IMediaStreamPlayer.h |
|
bool Play() |
Continues play of the current media. | IMediaStreamPlayer.h |
|
bool Previous() |
Goes to the previous item in the playlist. Only possible with playlist sources. | IMediaStreamPlayer.h |
|
bool Rewind() |
Seeks to the start of the current media. | IMediaStreamPlayer.h |
|
bool SetPlaybackState
(
EMediaStreamPlaybackState InState |
Sets the media player playback state. | IMediaStreamPlayer.h |
|
void SetPlayerConfig
(
const FMediaStreamPlayerConfig& InPlayerConfig |
Update the current player's (and any newly set player's) config. | IMediaStreamPlayer.h |
|
bool SetPlaylistIndex
(
int32 InIndex |
Setter for events. | IMediaStreamPlayer.h |
|
bool SetRequestedSeekFrame
(
int32 InFrame |
Sets the frame in the currently playing player, if possible. | IMediaStreamPlayer.h |
|
bool SetRequestedSeekTime
(
float InTime |
Sets the time in the currently playing player, if possible. | IMediaStreamPlayer.h |
|
void SetTextureConfig
(
const FMediaStreamTextureConfig& InTextureConfig |
Update the current texture's (and any newly set texture's) config. | IMediaStreamPlayer.h |
|