Platforms to show: All Mac Windows Linux Cross-Platform
MFPMediaPlayerMBS.AspectRatioMode as Integer
Function:
The current aspect-ratio correction mode.
Notes:
This mode controls whether the aspect ratio of the video is preserved during playback.
See VideoARMode* constants.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
This mode controls whether the aspect ratio of the video is preserved during playback.
See VideoARMode* constants.
(Read and Write property)
MFPMediaPlayerMBS.Balance as Single
Function:
The current audio balance.
Notes:
The value can be any number in the following range (inclusive).
If the value is zero, the left and right channels are at equal volumes. The default value is zero.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
The value can be any number in the following range (inclusive).
| Value | Meaning |
| -1.0 | The left channel is at full volume; the right channel is silent. |
| +1.0 | The right channel is at full volume; the left channel is silent. |
If the value is zero, the left and right channels are at equal volumes. The default value is zero.
(Read and Write property)
MFPMediaPlayerMBS.BorderColor as Color
Function:
The current color of the video border.
Notes:
The border color is used to letterbox the video.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
The border color is used to letterbox the video.
(Read and Write property)
MFPMediaPlayerMBS.Duration as Double
Function:
Gets the playback duration of the current media item.
Notes:
This method calculates the playback duration, taking into account the start and stop times for the media item. To set the start and stop times, use StartPosition and StopPosition properties on the media item. To get the actual duration of the underlying media file, regardless of start and stop times, use Duration property on the item.
For example, suppose that you load a 30-second audio file and set the start time equal to 2 seconds and stop time equal to 10 seconds. The MFPMediaItemMBS.Duration method will return 30 seconds, but the MFPMediaPlayerMBS.Duration method will return 8 seconds.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
This method calculates the playback duration, taking into account the start and stop times for the media item. To set the start and stop times, use StartPosition and StopPosition properties on the media item. To get the actual duration of the underlying media file, regardless of start and stop times, use Duration property on the item.
For example, suppose that you load a 30-second audio file and set the start time equal to 2 seconds and stop time equal to 10 seconds. The MFPMediaItemMBS.Duration method will return 30 seconds, but the MFPMediaPlayerMBS.Duration method will return 8 seconds.
(Read only property)
MFPMediaPlayerMBS.FastestSupportedRateForward as Single
Function:
Queries the fastest supported forward playback rates.
Notes:
Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read only property)
MFPMediaPlayerMBS.FastestSupportedRateReverse as Single
Function:
Queries the fastest supported reverse playback rates.
Notes:
Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read only property)
MFPMediaPlayerMBS.Handle as Integer
Function:
The internal object reference.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.IdealVideoMaxHeight as Integer
Function:
Gets the maximum height of video size that can be displayed without significantly degrading performance or image quality.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.IdealVideoMaxWidth as Integer
Function:
Gets the maximum width of video sizes that can be displayed without significantly degrading performance or image quality.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.IdealVideoMinHeight as Integer
Function:
Gets the minimum height of video sizes that can be displayed without significantly degrading performance or image quality.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.IdealVideoMinWidth as Integer
Function:
Gets the minimum width of video sizes that can be displayed without significantly degrading performance or image quality.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.Looping as Boolean
Function:
Whether to loop video.
Notes:
If set to true, the plugin will call Play automatically when playback ended.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.1 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
If set to true, the plugin will call Play automatically when playback ended.
(Read and Write property)
MFPMediaPlayerMBS.MediaItem as MFPMediaItemMBS
Function:
Current media item.
Notes:
Setting the MediaItem property is asynchronous. Therefore, while set is pending, get will not return the media item that was just set. Instead, the application should implement MediaItemSet event to know when it is done.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Setting the MediaItem property is asynchronous. Therefore, while set is pending, get will not return the media item that was just set. Instead, the application should implement MediaItemSet event to know when it is done.
(Read and Write property)
Some examples using this property:
MFPMediaPlayerMBS.Mute as Boolean
Function:
Whether the audio is muted.
Notes: (Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read and Write property)
MFPMediaPlayerMBS.NativeVideoAspectRateHeight as Integer
Function:
The picture aspect ratio of the video.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.NativeVideoAspectRateWidth as Integer
Function:
The picture aspect ratio of the video.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.NativeVideoHeight as Integer
Function:
The height of the video, in pixels.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.NativeVideoWidth as Integer
Function:
The width of the video, in pixels.
Notes: (Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes: (Read only property)
MFPMediaPlayerMBS.Position as Double
Function:
The playback position.
Notes:
If you call this method while playback is stopped, the new position takes effect after playback resumes.
This method completes asynchronously. When the operation completes, the PositionSet event is raised.
If playback was started before SetPosition is called, playback resumes at the new position. If playback was paused, the video is refreshed to display the current frame at the new position.
If you make two consecutive calls to SetPosition, and the second call is made before the first call has completed, the second call supersedes the first. The status code for the superseded call is set to false in the event data for that call. This behavior prevents excessive latency from repeated calls to SetPosition, as each call may force the media source to perform a relatively lengthy seek operation.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
If you call this method while playback is stopped, the new position takes effect after playback resumes.
This method completes asynchronously. When the operation completes, the PositionSet event is raised.
If playback was started before SetPosition is called, playback resumes at the new position. If playback was paused, the video is refreshed to display the current frame at the new position.
If you make two consecutive calls to SetPosition, and the second call is made before the first call has completed, the second call supersedes the first. The status code for the superseded call is set to false in the event data for that call. This behavior prevents excessive latency from repeated calls to SetPosition, as each call may force the media source to perform a relatively lengthy seek operation.
(Read and Write property)
MFPMediaPlayerMBS.Rate as Single
Function:
The current playback rate.
Notes:
The playback rate is expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
The playback rate is expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read and Write property)
MFPMediaPlayerMBS.SlowestSupportedRateForward as Single
Function:
Queries the slowest supported forward playback rates.
Notes:
Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read only property)
MFPMediaPlayerMBS.SlowestSupportedRateReverse as Single
Function:
Queries the slowest supported reverse playback rates.
Notes:
Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Playback rates are expressed as a ratio of the current rate to the normal rate. For example, 1.0 indicates normal playback speed, 0.5 indicates half speed, and 2.0 indicates twice speed. Positive values indicate forward playback, and negative values indicate reverse playback.
(Read only property)
MFPMediaPlayerMBS.State as Integer
Function:
The current playback state of the MFPlay player object.
Notes:
See State* constants.
This property can be read after the player object has been shut down.
Many of the player methods complete asynchronously. While an asynchronous operation is pending, the current state is not updated until the operation completes. When the operation completes, the application receives an event.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
See State* constants.
This property can be read after the player object has been shut down.
Many of the player methods complete asynchronously. While an asynchronous operation is pending, the current state is not updated until the operation completes. When the operation completes, the application receives an event.
(Read only property)
MFPMediaPlayerMBS.VideoWindow as Integer
Function:
Gets the window where the video is displayed.
Notes:
Returns HWND as integer.
(Read only property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Returns HWND as integer.
(Read only property)
MFPMediaPlayerMBS.Volume as Single
Function:
The audio volume.
Notes:
Volume is expressed as an attenuation level, where 0.0 indicates silence and 1.0 indicates full volume (no attenuation).
If you call this method before playback starts, the setting is applied after playback starts.
This method does not change the master volume level for the player's audio session. Instead, it adjusts the per-channel volume levels for audio stream(s) that belong to the current media item. Other streams in the audio session are not affected.
(Read and Write property)
| Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
| property | Windows Media Foundation | MBS WinFrameworks Plugin | 20.0 | ❌ No | ✅ Yes | ❌ No | ❌ No | Desktop, Console & Web |
Notes:
Volume is expressed as an attenuation level, where 0.0 indicates silence and 1.0 indicates full volume (no attenuation).
If you call this method before playback starts, the setting is applied after playback starts.
This method does not change the master volume level for the player's audio session. Instead, it adjusts the per-channel volume levels for audio stream(s) that belong to the current media item. Other streams in the audio session are not affected.
(Read and Write property)
The items on this page are in the following plugins: MBS WinFrameworks Plugin.
Links
MBS Xojo tutorial videos
