Media Work All In One

Pautinka / 使用手册

Media Work All In One

在 Unreal Engine 中播放视频、同步声音并操作播放器。

把视频放进场景中的显示器,把透明 MOV 做成全息影像,或让玩家走到屏幕前按下暂停。

Unreal Engine 5.3–5.8 · Windows 64-bit · 1.0

从 Fab 安装

  1. 将 Media Work 加入 Fab 库。关闭 Unreal Editor,用同一个 Epic 账号登录启动器。
  2. 在 Unreal Engine > Library > Fab Library 中选择 Install to Engine,选择项目所用的版本。支持 Windows 64 位和 Unreal Engine 5.3–5.8。
  3. 在 Edit > Plugins 启用插件并重启编辑器。打开 Tools > Pautinka > Media Work,播放自带的示例视频。

下载英文快速指南

导入与替换文件

  1. 从 Content Browser 选择已有资源,也可从磁盘导入。使用 MP3 或兼容的 MP4、MOV。普通 MP4 建议使用 H.264 视频和 AAC 音频。
  2. 预览画面和声音并保存资源。打包游戏时,把导入的源文件留在项目中。
  3. 要替换源文件,在资源上右键选择 Reimport,再用原来的播放器检查结果。

在材质中播放视频和声音

材质显示画面。Media Work 从同一播放会话读取声音,让声音和画面同步。

  1. 在 Video to texture 选取视频并保存纹理资源。
  2. 在 Material Editor 添加 Media Work Video Texture。想让屏幕自发光,选择 Unlit,把 RGB 接到 Emissive Color。
  3. 创建材质实例,把保存的纹理赋给 MediaWorkVideo,再把实例应用到网格体。用于控件时,选择 UI 材质。
  4. 要手动播放,在蓝图中对纹理调用 Start。用同一个会话控制暂停、进度和音量。
Media Work Video Texture · RGB → Emissive Color · Opacity → Opacity
Media Work Video Texture · RGB → Emissive Color · Opacity → Opacity

透明 MOV 和边缘遮罩

  1. 选择带 Alpha 通道的 MOV,例如 ProRes 4444。在反差明显的背景上检查透明效果。
  2. 使用 Translucent 材质。连接 RGB 显示画面,并把 Opacity 输出接到材质的 Opacity 输入。
  3. 可从 50 个遮罩中选择一个,为独立视频纹理添加柔和边缘。Red 读取灰度图,Alpha 读取 PNG 透明度。白色或完全不透明的区域保留画面。
  4. 自制遮罩时,保留实心中心,让渐变在图像边缘前降到零。遮罩与原视频的透明度一起生效。
ProRes 4444 · Alpha
ProRes 4444 · Alpha
Video texture · Soft Lens
Video texture · Soft Lens

显示完整播放器

  1. 在 Video player 选择视频和样式。Screen 在视口显示播放器,Plane 把它放在场景中的平面上,Texture 则输出带画面、边框和按钮的纹理。
  2. 使用 Auto 匹配视频比例,或手动输入比例。可在边框内移动和缩放画面,标题可选。
  3. 保存后,在蓝图调用 Open Saved Player。通过返回的播放器取得表面、会话和 Get Output Texture。
Media Work · Video player
Media Work · Video player
Open Saved Player · Screen / Plane / Texture
Open Saved Player · Screen / Plane / Texture

让按钮控制指定播放器

  1. 把播放器表面接到 Configure Media Work Player Controls。选择光标或按键、角色和最大交互距离。
  2. 平面可以使用射线。自定义材质可以用 Update Pointer UV 传入指针位置,每个方向为 0 到 1,同时传入按下和松开。
  3. 在自定义 UI 加入 Media Work Controls,绑定播放会话或播放器 ID。用两块屏幕测试独立暂停,并在拖动进度条时走出交互范围。
Configure Media Work Player Controls
Configure Media Work Player Controls

音频与播放列表

  1. 在 Audio player 中加入 MP3 或已导入的音源。可以从列表选择,也可以播放上一首或下一首。
  2. 设置循环、随机、音量和六段均衡器。曲名和列表可分别显示。
  3. 保存列表。在 Widget Blueprint 中添加 Media Work Player,使用该资源调用 Open Playlist。
Media Work · Audio playlist
Media Work · Audio playlist

绘制自己的边框和按钮

  1. 复制一个播放器样式和需要修改的按钮样式。在图形编辑器中打开 SVG 模板。
  2. 绘制四个角、四条边、可选装饰、按钮、轨道和滑块。四周留出透明余量。隐藏参考线并导出 RGBA PNG。
  3. 在 Frame 中分配部件。使用图集时,将部件的像素坐标除以图像宽和高,填写 UV Min 和 UV Max。
  4. 用 Corner Anchors、Corner Arm Widths 和 Side Profiles 对齐接缝。Corner Offsets 是相对角大小的百分比,负值向左或向上。Join Overlap 让直边伸到角的下方。
  5. 保留原色、整块着色或只改选中区域。色彩遮罩的白色部分可以改色。测试宽屏、方形、竖屏和紧凑的音频播放器。
Media Work · Skin atlas
Media Work · Skin atlas

添加字幕

  1. 导入 SRT、VTT、ASS、SSA、TTML、DFXP 或 SBV,检查文字和时间。
  2. 在视频播放器里启用字幕,选取字幕轨和语言。
  3. 选择包含所需字符的字体。西里尔字母可用 Golos Text。需要时调整时间偏移,然后保存。
Media Work · Golos Text
Media Work · Golos Text

使用视频特效

  1. 在 Video Effects 中选取视频和预设,与播放中的原片比较。
  2. 调整强度、颜色及其他选项。用 Preserve Alpha 保留透明度。
  3. 保存特效。在蓝图里接入播放会话,再将输出纹理用于材质。
Video · Original
Video · Original
Video · Effect
Video · Effect

将相机画面输出到纹理

  1. 在 Camera 中选取场景相机并检查画面。
  2. 设置尺寸、更新频率及可选特效,然后保存设置。
  3. 给 Media Work Camera Texture 指定相机和设置,使用 Get Output Texture 或 Apply to Material。
Media Work · Camera texture
Media Work · Camera texture
Media Work · Camera texture + effect
Media Work · Camera texture + effect

选择输出质量

  1. 直接输出使用源画面。打开处理后,可设置尺寸、滤波和 Alpha。完整播放器有独立的输出设置。
  2. 缩放时可用平滑滤波,像素画可关闭。16 位过渡更平滑,8 位占用的纹理内存较少。
  3. 分别调整视频纹理、完整播放器和相机的更新频率,然后在游戏场景中检查。

打包 Windows 游戏

  1. 保存项目引用的媒体、材质、样式和播放器。检查运行时加载的资源是否包含在包内。
  2. 为 Windows 64 位打包并单独运行。测试画面、声音、进度、透明和交互。
  3. 如果文件只在编辑器中打开,检查源资源和它依赖的文件是否已打包。

蓝图节点参考

展开类别和节点,查看它的用途和真实 Unreal 引脚截图。上面的材质图展示了 RGB 和 Opacity 的接法。

参考图中的节点名称、引脚和提示来自 Unreal 的英文界面。

MWCameraCaptureComponent · 13
Apply to Material

Connects the live picture to a texture parameter. The connection follows changes in output size.

MWCameraCaptureComponent.ApplyToMaterial
Apply to Material
Apply to Material
Close Camera

Stops capture and releases this camera's picture buffers and material connections.

MWCameraCaptureComponent.CloseCamera
Close Camera
Close Camera
Set camera texture settings

Creates a live camera texture with the saved size, update rate and effect.

MWCameraCaptureComponent.Configure
Set camera texture settings
Set camera texture settings
Update camera texture

Draws one new frame. Use this when automatic updates are paused.

MWCameraCaptureComponent.DrawFrame
Update camera texture
Update camera texture
Get Output Texture

Returns the finished live texture, or no texture while the camera is unavailable.

MWCameraCaptureComponent.GetOutputTexture
Get Output Texture
Get Output Texture
Choose source camera

Follows this camera. Leave empty to follow the player's camera during the game.

MWCameraCaptureComponent.SetCamera
Choose source camera
Choose source camera
Set Effect

Chooses a scene effect without opening a second camera. An empty choice restores the camera picture.

MWCameraCaptureComponent.SetEffect
Set Effect
Set Effect
Set Effect Color

Changes a named color or pattern placement in an effect part. Other cameras keep their own settings.

MWCameraCaptureComponent.SetEffectColor
Set Effect Color
Set Effect Color
Set Effect Strength

Sets how strongly the selected effect changes the picture, from zero to one.

MWCameraCaptureComponent.SetEffectStrength
Set Effect Strength
Set Effect Strength
Set Effect Value

Changes a named value in an effect part. Parts count from zero. Invalid names or values return false.

MWCameraCaptureComponent.SetEffectValue
Set Effect Value
Set Effect Value
Set Output Size

Changes the exact output size. Unsupported sizes are rejected, without silently choosing a smaller picture.

MWCameraCaptureComponent.SetOutputSize
Set Output Size
Set Output Size
Pause camera updates

Keeps the last frame without rendering the scene again until updates resume.

MWCameraCaptureComponent.SetPaused
Pause camera updates
Pause camera updates
Set Update Rate

Sets automatic updates per second, from 1 to 120. Pausing still keeps the last frame.

MWCameraCaptureComponent.SetUpdateRate
Set Update Rate
Set Update Rate
MWEffectPlayer · 10
Apply to Material

Connects the processed picture and its transparency to a texture parameter. The connection follows changes of effect and output size.

MWEffectPlayer.ApplyToMaterial
Apply to Material
Apply to Material
Close

Releases this effect's picture buffers and material connections. The shared player and its sound continue playing.

MWEffectPlayer.Close
Close
Close
Get Player Id

The ID of the shared player used by this effect.

MWEffectPlayer.GetPlayerId
Get Player Id
Get Player Id
Preserve Alpha

Keeps the original video's transparency. Turn off only when you want a solid rectangular picture.

MWEffectPlayer.PreserveAlpha
Preserve Alpha
Preserve Alpha
Draw video effect

Processes the current video frame and returns the finished texture.

MWEffectPlayer.Render
Draw video effect
Draw video effect
Change effect color

Changes a color in a pass of the selected effect.

MWEffectPlayer.SetColor
Change effect color
Change effect color
Set video effect

Applies this effect and its saved settings to the video.

MWEffectPlayer.SetEffect
Set video effect
Set video effect
Change effect value

Changes one setting in a pass of the selected effect.

MWEffectPlayer.SetScalar
Change effect value
Change effect value
Set Strength

Sets how strongly the effect changes the picture, from zero to one.

MWEffectPlayer.SetStrength
Set Strength
Set Strength
Use Session

Processes this player's live picture using its own playback clock. Sound and controls keep using the same player. An optional texture can supply its masked picture.

MWEffectPlayer.UseSession
Use Session
Use Session
MWMaskedVideoTexture · 10
Apply video to material

Connects this live texture to a texture parameter in a material.

MWMaskedVideoTexture.ApplyToMaterial
Apply video to material
Apply video to material
Close player surface

Stops drawing this texture.

MWMaskedVideoTexture.CloseVideo
Close player surface
Close player surface
Update masked video

Draw the current video frame and its edge fade into this texture.

MWMaskedVideoTexture.DrawFrame
Update masked video
Update masked video
Player ID

This session has its own unique ID. Use it to address only this player.

MWMaskedVideoTexture.GetPlayerId
Player ID
Player ID
Change edge fade

Apply a saved mask to this video texture. An empty choice restores the original video transparency.

MWMaskedVideoTexture.SetMask
Change edge fade
Change edge fade
Use edge fade

Switch the chosen mask on or off. The original video alpha is preserved.

MWMaskedVideoTexture.SetMaskEnabled
Use edge fade
Use edge fade
Reveal the faint edge

Zero preserves the painted fade. Higher values reveal more of its faint outer edge without cutting off the gradient.

MWMaskedVideoTexture.SetMaskSoftness
Reveal the faint edge
Reveal the faint edge
Set picture framing

Moves or scales the picture inside the video texture.

MWMaskedVideoTexture.SetVideoFraming
Set picture framing
Set picture framing
Start video texture

Starts live video directly in this texture.

MWMaskedVideoTexture.Start
Start video texture
Start video texture
Use existing session

Shows video from an existing playback session.

MWMaskedVideoTexture.UseSession
Use existing session
Use existing session
MWMediaController · 12
Close source

Closes this player’s source and sound. Its ID and texture remain available for reopening.

MWMediaController.Close
Close source
Close source
Finished video texture

Connect this texture to your material. It includes the chosen edge fade.

MWMediaController.GetOutputTexture
Finished video texture
Finished video texture
Player ID

This session has its own unique ID. Use it to address only this player.

MWMediaController.GetPlayerId
Player ID
Player ID
Open media

Opens a saved media asset and connects its sound to this game world.

MWMediaController.OpenMedia
Open media
Open media
Pause

Pauses playback and keeps its position.

MWMediaController.Pause
Pause
Pause
Play

Starts or resumes the current track.

MWMediaController.Play
Play
Play
Seek

Moves to a time in seconds. Returns false when the source cannot seek.

MWMediaController.Seek
Seek
Seek
Set picture framing

Resizes and moves only this controller’s video inside its fixed output. After the first change, get Output Texture again and assign it to your material or UI: framing may create a processed output. The sound and session stay the same.

MWMediaController.SetVideoFraming
Set picture framing
Set picture framing
Change edge fade

Apply a saved mask to this video texture. An empty choice restores the original video transparency.

MWMediaController.SetVideoMask
Change edge fade
Change edge fade
Set volume

Sets this player's volume from 0 for silent to 1 for full volume.

MWMediaController.SetVolume
Set volume
Set volume
Stop

Stops playback and returns to the beginning. The source stays selected.

MWMediaController.StopPlayback
Stop
Stop
Play or pause

Pauses a playing track or resumes a paused track.

MWMediaController.TogglePlayback
Play or pause
Play or pause
MWMediaSession · 33
Can seek

Reports whether the source can jump to a chosen time.

MWMediaSession.CanSeek
Can seek
Can seek
Change track

Use 1 for the next track, -1 for the previous track and 0 to restart the current track.

MWMediaSession.ChangeTrack
Change track
Change track
Close source

Stops playback and releases the decoder and sound. Reopen Source can open it again.

MWMediaSession.Close
Close source
Close source
Find player by ID

Finds only the matching player in this game world. An unknown ID returns no player. Connect the result to Play, Pause or another command.

MWMediaSession.FindPlayerById
Find player by ID
Find player by ID
Source duration

Returns the length in seconds, or zero while it is unknown.

MWMediaSession.GetDuration
Source duration
Source duration
Get six-band gains

Six bands from bass to treble. Zero keeps the original sound; positive values boost and negative values reduce the band. Each track keeps the chosen settings. A band can only affect frequencies present in the recording.

MWMediaSession.GetEqualizer
Get six-band gains
Get six-band gains
Does playlist repeat

Tells you whether the playlist starts over.

MWMediaSession.GetPlaylistRepeat
Does playlist repeat
Does playlist repeat
Is shuffled

Tells you whether the playlist plays in shuffled order.

MWMediaSession.GetPlaylistShuffle
Is shuffled
Is shuffled
Playback position

Returns the current time in seconds for a clock or progress bar.

MWMediaSession.GetPosition
Playback position
Playback position
Get current subtitle lines

Returns the lines at this player’s real playback time. Use them in your own UI. Hidden, stopped or invalid subtitles return empty text.

MWMediaSession.GetSubtitleText
Get current subtitle lines
Get current subtitle lines
Track count

The number of tracks in this playlist.

MWMediaSession.GetTrackCount
Track count
Track count
Playlist track index

Returns the selected row from zero, or -1 for a single source.

MWMediaSession.GetTrackIndex
Playlist track index
Playlist track index
Track name

The name of a playlist row. Use -1 for the current track.

MWMediaSession.GetTrackTitle
Track name
Track name
Get volume

Returns this player's loudness from 0 to 1.

MWMediaSession.GetVolume
Get volume
Get volume
Reopen source

Reopens the selected source after closing it or after an error.

MWMediaSession.Open
Reopen source
Reopen source
Open media

Opens a saved media asset and connects its sound to this game world.

MWMediaSession.OpenMedia
Open media
Open media
Open playlist

Starts a saved playlist. Replace any missing tracks before playing.

MWMediaSession.OpenPlaylist
Open playlist
Open playlist
Pause

Pauses playback and keeps its position.

MWMediaSession.Pause
Pause
Pause
Play

Starts or resumes the current track.

MWMediaSession.Play
Play
Play
Reset equalizer

Returns all six gains to zero without restarting the track or changing its volume.

MWMediaSession.ResetEqualizer
Reset equalizer
Reset equalizer
Seek

Moves to a time in seconds. Returns false when the source cannot seek.

MWMediaSession.Seek
Seek
Seek
Play playlist row

Plays the chosen playlist row. The first row is zero.

MWMediaSession.SelectTrack
Play playlist row
Play playlist row
Set equalizer

Sets 60, 150, 400, 1000, 2500 and 8000 Hz from -12 to +12 dB. Missing band values become zero.

MWMediaSession.SetEqualizer
Set equalizer
Set equalizer
Set one equalizer band

Changes one gain from -12 to +12 dB. Band zero is 60 Hz, then 150, 400, 1000, 2500 and 8000 Hz. Other bands stay as they are. Returns false for an invalid band or value.

MWMediaSession.SetEqualizerBand
Set one equalizer band
Set one equalizer band
Set repeat

Repeats the current source at its end. Playlists have their own repeat setting.

MWMediaSession.SetLooping
Set repeat
Set repeat
Set playlist repeat

Starts a new pass after the last track. Turn off to stop when this pass ends.

MWMediaSession.SetPlaylistRepeat
Set playlist repeat
Set playlist repeat
Set shuffled order

Changes the order of upcoming tracks. Each track plays once per pass, and the selected track starts first. Previous returns through the tracks you have heard.

MWMediaSession.SetPlaylistShuffle
Set shuffled order
Set shuffled order
Set subtitle language

Choose a language found in this file. The default uses the language saved in the source.

MWMediaSession.SetSubtitleLanguage
Set subtitle language
Set subtitle language
Set subtitle visibility

Shows or hides captions in views sharing this session. Video, sound and position keep playing as before.

MWMediaSession.SetSubtitlesEnabled
Set subtitle visibility
Set subtitle visibility
Set subtitle track

Choose imported subtitles from Content. Players can share this file and keep their own appearance.

MWMediaSession.SetSubtitleTrack
Set subtitle track
Set subtitle track
Set volume

Sets this player's volume from 0 for silent to 1 for full volume.

MWMediaSession.SetVolume
Set volume
Set volume
Stop

Stops playback and returns to the beginning. The source stays selected.

MWMediaSession.StopPlayback
Stop
Stop
Play or pause

Pauses a playing track or resumes a paused track.

MWMediaSession.TogglePlayback
Play or pause
Play or pause
MWSubtitleAsset · 5
Get saved subtitle language

Returns the subtitle language used by default.

MWSubtitleAsset.GetDefaultLanguage
Get saved subtitle language
Get saved subtitle language
Get subtitle languages

Lists the subtitle languages in this asset.

MWSubtitleAsset.GetLanguages
Get subtitle languages
Get subtitle languages
Get subtitle lines at time

Returns the lines at the given time, with the saved offset and language.

MWSubtitleAsset.GetTextAtTime
Get subtitle lines at time
Get subtitle lines at time
Read subtitle file

Imports text and timing. Set the font and appearance here. ASS drawings, animation and karaoke need an ordinary timed-text export first.

MWSubtitleAsset.ImportFile
Read subtitle file
Read subtitle file
Check subtitles and font

Checks timing, appearance, language and letters. If something cannot be used, returns false and explains why.

MWSubtitleAsset.Validate
Check subtitles and font
Check subtitles and font
MWSubtitleFontAsset · 1
Check font letters

Checks every letter against this font. Returns false and names the first missing character; it does not substitute another font.

MWSubtitleFontAsset.SupportsText
Check font letters
Check font letters
MWVideoTexture · 3
Apply video to material

Connects this live texture to a texture parameter in a material.

MWVideoTexture.ApplyToMaterial
Apply video to material
Apply video to material
Close video texture

Stops the video and releases its playback resources.

MWVideoTexture.CloseVideo
Close video texture
Close video texture
Start video texture

Starts live video directly in this texture.

MWVideoTexture.Start
Start video texture
Start video texture
MWMediaControlsWidget · 5
Bind Player Id

Connects only to the player with this ID in this world. An unknown ID disconnects the panel and returns false.

MWMediaControlsWidget.BindPlayerId
Bind Player Id
Bind Player Id
Set Button Styles

Replaces the play and secondary button artwork for this panel only. Choose a theme first.

MWMediaControlsWidget.SetButtonStyles
Set Button Styles
Set Button Styles
Set Preset

Changes how many controls this panel shows without restarting playback.

MWMediaControlsWidget.SetPreset
Set Preset
Set Preset
Set Style

Changes this panel's theme without changing another panel or restarting playback.

MWMediaControlsWidget.SetStyle
Set Style
Set Style
Use Session

Connects this panel to an existing player's picture and sound. It does not open another player.

MWMediaControlsWidget.UseSession
Use Session
Use Session
MWPlayerInteractionComponent · 11
Begin Interaction

Enters control mode if the character is within range.

MWPlayerInteractionComponent.BeginInteraction
Begin Interaction
Begin Interaction
Can Control

Whether this input controller can currently operate the selected player.

MWPlayerInteractionComponent.CanControl
Can Control
Can Control
End Interaction

Leaves control mode and cancels held buttons or an unfinished seek.

MWPlayerInteractionComponent.EndInteraction
End Interaction
End Interaction
Get Player Id

The ID of the one player selected by this input controller.

MWPlayerInteractionComponent.GetPlayerId
Get Player Id
Get Player Id
Is in Range

Whether the character is within the configured distance of the selected player.

MWPlayerInteractionComponent.IsInRange
Is in Range
Is in Range
Press Pointer

Presses the selected player's button at the current pointer position, within the allowed distance.

MWPlayerInteractionComponent.PressPointer
Press Pointer
Press Pointer
Release Pointer

Releases a held player button or finishes a slider drag. Leaving the interaction zone cancels the action.

MWPlayerInteractionComponent.ReleasePointer
Release Pointer
Release Pointer
Send Command

Sends a playback command to this player only, while the character is in range and control mode is active.

MWPlayerInteractionComponent.SendCommand
Send Command
Send Command
Send Control Key

Sends a navigation or activation key to the selected player's on-screen controls.

MWPlayerInteractionComponent.SendControlKey
Send Control Key
Send Control Key
Update Pointer Ray

Traces a world ray to the selected player plane. Other blocking objects stop the ray.

MWPlayerInteractionComponent.UpdatePointerRay
Update Pointer Ray
Update Pointer Ray
Update Pointer UV

Moves over a player displayed in your own material. Supply its actual UV coordinates; distance is still checked.

MWPlayerInteractionComponent.UpdatePointerUV
Update Pointer UV
Update Pointer UV
MWPlayerInteractionLibrary · 1
Configure Media Work Player Controls

Selects one player for this controller, chooses cursor or buttons, and sets the required interaction distance. Calling it again changes the selected player.

MWPlayerInteractionLibrary.ConfigurePlayerControls
Configure Media Work Player Controls
Configure Media Work Player Controls
MWPlayerOutput · 8
Close

Closes this output and releases its screen, plane, texture and playback session.

MWPlayerOutput.Close
Close
Close
Get Output Texture

Returns the complete live player texture for texture and plane outputs.

MWPlayerOutput.GetOutputTexture
Get Output Texture
Get Output Texture
Get Plane

Returns the plane created for a saved plane output.

MWPlayerOutput.GetPlane
Get Plane
Get Plane
Get Player Id

Returns the ID used to control only this player.

MWPlayerOutput.GetPlayerId
Get Player Id
Get Player Id
Get Screen Player

Returns the screen widget when the saved output is the game screen.

MWPlayerOutput.GetScreenPlayer
Get Screen Player
Get Screen Player
Get Session

Returns this output's playback session, shared by its picture, sound and controls.

MWPlayerOutput.GetSession
Get Session
Get Session
Get Status

Shows opening progress or the reason why this output could not play.

MWPlayerOutput.GetStatus
Get Status
Get Status
Get Surface

Returns the surface component used to send pointer and key input to a player texture or plane.

MWPlayerOutput.GetSurface
Get Surface
Get Surface
MWPlayerOutputLibrary · 1
Open Saved Player

Opens the saved player on the game screen, on a plane or as a complete texture, according to its output setting. Keep the returned object to control and close this player.

MWPlayerOutputLibrary.OpenSavedPlayer
Open Saved Player
Open Saved Player
MWPlayerPlane · 5
Open Player

Opens a saved player on this plane with its picture, frame, buttons and sound.

MWPlayerPlane.OpenPlayer
Open Player
Open Player
Player UVTo World

Converts texture UV coordinates into a world point on this plane.

MWPlayerPlane.PlayerUVToWorld
Player UVTo World
Player UVTo World
Ray to Player UV

Finds where a ray meets this plane, including beyond its edges for a held slider.

MWPlayerPlane.RayToPlayerUV
Ray to Player UV
Ray to Player UV
Set Plane Width

Changes plane width while preserving the displayed player's proportions.

MWPlayerPlane.SetPlaneWidth
Set Plane Width
Set Plane Width
World to Player UV

Converts a point on this plane to texture UV coordinates. Points beyond its edges also return their coordinates.

MWPlayerPlane.WorldToPlayerUV
World to Player UV
World to Player UV
MWPlayerRenderTexture · 1
Apply to Material

Connects the complete player picture, frame and buttons to a material texture parameter.

MWPlayerRenderTexture.ApplyToMaterial
Apply to Material
Apply to Material
MWPlayerSurfaceComponent · 20
Bind Player Id

Connects to this player's ID in the same world. An unknown ID disconnects this surface.

MWPlayerSurfaceComponent.BindPlayerId
Bind Player Id
Bind Player Id
Cancel Pointer

Cancels a held button or an unfinished seek without applying it. Use this when the pointer loses control.

MWPlayerSurfaceComponent.CancelPointer
Cancel Pointer
Cancel Pointer
Close

Stops drawing and releases the surface. A session opened by this surface is also closed.

MWPlayerSurfaceComponent.Close
Close
Close
Get Output Size

The actual width and height of the complete player texture.

MWPlayerSurfaceComponent.GetOutputSize
Get Output Size
Get Output Size
Get Player Id

The ID of the player used by this surface and its buttons.

MWPlayerSurfaceComponent.GetPlayerId
Get Player Id
Get Player Id
Move Pointer

Moves the pointer over the texture. UV starts at 0,0 in the top-left and ends at 1,1 in the bottom-right.

MWPlayerSurfaceComponent.MovePointer
Move Pointer
Move Pointer
Open Player

Opens a saved player and draws its video, frame and controls into one live texture.

MWPlayerSurfaceComponent.OpenPlayer
Open Player
Open Player
Pointer Down

Presses the primary button at these texture coordinates. Pair it with Pointer Up, including after a drag.

MWPlayerSurfaceComponent.PointerDown
Pointer Down
Pointer Down
Pointer Up

Releases the primary button. A slider drag may finish outside the texture; a button released outside is cancelled.

MWPlayerSurfaceComponent.PointerUp
Pointer Up
Pointer Up
Redraw

Draws a new player frame now. Normally the component updates it automatically.

MWPlayerSurfaceComponent.Redraw
Redraw
Redraw
Send Control Key

Sends a keyboard or gamepad key to this player's controls only.

MWPlayerSurfaceComponent.SendControlKey
Send Control Key
Send Control Key
Set High Precision Output

Chooses smoother 16-bit output or smaller 8-bit output without restarting the video.

MWPlayerSurfaceComponent.SetHighPrecisionOutput
Set High Precision Output
Set High Precision Output
Set Output Quality

Sets the longest texture side in pixels and the redraw rate. Zero frames per second updates every game frame.

MWPlayerSurfaceComponent.SetOutputQuality
Set Output Quality
Set Output Quality
Set Player Title

Sets optional text above this player's video. Empty text removes the heading and its space.

MWPlayerSurfaceComponent.SetPlayerTitle
Set Player Title
Set Player Title
Set Show Controls

Shows or hides the controls in this texture without changing playback.

MWPlayerSurfaceComponent.SetShowControls
Set Show Controls
Set Show Controls
Set Show Subtitles

Shows or hides subtitles in the player texture without changing playback.

MWPlayerSurfaceComponent.SetShowSubtitles
Set Show Subtitles
Set Show Subtitles
Set Style

Changes this surface's frame and buttons without restarting the video.

MWPlayerSurfaceComponent.SetStyle
Set Style
Set Style
Set Video Aspect Ratio

Sets a picture width divided by height. Zero restores automatic video proportions.

MWPlayerSurfaceComponent.SetVideoAspectRatio
Set Video Aspect Ratio
Set Video Aspect Ratio
Set Video Framing

Changes the picture size and position inside this surface. The frame and its buttons stay in place.

MWPlayerSurfaceComponent.SetVideoFraming
Set Video Framing
Set Video Framing
Use Session

Draws and controls an existing session. Closing this surface will leave that session running.

MWPlayerSurfaceComponent.UseSession
Use Session
Use Session
MWPlayerWidget · 9
Close Player

Closes only the playback session created by this widget.

MWPlayerWidget.ClosePlayer
Close Player
Close Player
Open Media

Opens a media asset and connects its sound to this widget's game world.

MWPlayerWidget.OpenMedia
Open Media
Open Media
Open Playlist

Opens an audio playlist with its saved title, list and theme settings.

MWPlayerWidget.OpenPlaylist
Open Playlist
Open Playlist
Set Audio Style

Changes the audio theme without restarting playback or changing the video theme.

MWPlayerWidget.SetAudioStyle
Set Audio Style
Set Audio Style
Set Display Title

Sets optional text above the video. Empty text removes the heading and its space.

MWPlayerWidget.SetDisplayTitle
Set Display Title
Set Display Title
Set Player Style

Changes the video theme without restarting playback or changing the audio theme.

MWPlayerWidget.SetPlayerStyle
Set Player Style
Set Player Style
Set Show Subtitles

Shows or hides subtitles in this widget immediately, without changing other views of the same session.

MWPlayerWidget.SetShowSubtitles
Set Show Subtitles
Set Show Subtitles
Set Video Framing

Changes the picture inside this frame without moving the buttons or restarting playback.

MWPlayerWidget.SetVideoFraming
Set Video Framing
Set Video Framing
Use Session

Connects an existing session. Closing the widget will not close a session owned elsewhere.

MWPlayerWidget.UseSession
Use Session
Use Session