Full screen events #2041

ne0rrmatrix · 2024-07-19T11:52:28Z

Feature/Proposal

Add Support for Full Screen Events for Windows, Android, iOS and Mac Catalyst.

Description of Change

Add event handlers to notify developer when full screen status changes.

API:

/// <summary>
/// Backing store for the <see cref="FullScreenState"/> property.
/// </summary>
public static readonly BindableProperty FullScreenProperty =
	BindableProperty.Create(nameof(FullScreenState), typeof(MediaElementScreenState), typeof(MediaElement), 
		MediaElementScreenState.Default, propertyChanged: OnFullScreenPropertyChanged);
/// <summary>
/// Gets the full screen state of the media element.
/// </summary>
public MediaElementScreenState FullScreenState
{
	get => (MediaElementScreenState)GetValue(FullScreenProperty);
	private set => SetValue(FullScreenProperty, value);
}

XAML:

<toolkit:MediaElement
    x:Name="MediaElement"
    ShouldAutoPlay="True"
    Source="https://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4"
    MetadataArtworkUrl="https://lh3.googleusercontent.com/pw/AP1GczNRrebWCJvfdIau1EbsyyYiwAfwHS0JXjbioXvHqEwYIIdCzuLodQCZmA57GADIo5iB3yMMx3t_vsefbfoHwSg0jfUjIXaI83xpiih6d-oT7qD_slR0VgNtfAwJhDBU09kS5V2T5ZML-WWZn8IrjD4J-g=w1792-h1024-s-no-gm"
    MetadataTitle="Big Buck Bunny"
    MetadataArtist="Blender Foundation"
    MediaEnded="OnMediaEnded"
    MediaFailed="OnMediaFailed"
    MediaOpened="OnMediaOpened"
    PositionChanged="OnPositionChanged"
    StateChanged="OnStateChanged"
    SeekCompleted="OnSeekCompleted"
    FullScreenStateChanged="MediaElement_FullScreenStateChanged"/>

Code Behind:

void MediaElement_FullScreenStateChanged(object? sender, FullScreenStateChangedEventArgs e) =>
	logger.LogInformation("FullScreen State Changed. Old State: {PreviousState}, New State: {NewState}", e.PreviousState, e.NewState);

Linked Issues

Fixes [Proposal] API that allows developers to hook a media element event and know the full screen status. #1927

PR Checklist

Has a linked Issue, and the Issue has been approved(bug) or Championed (feature/proposal)
Has tests (if omitted, state reason in description)
Has samples (if omitted, state reason in description)
Rebased on top of main at time of PR
Changes adhere to coding standard
Documentation created or updated: https://github.com/MicrosoftDocs/CommunityToolkit/pulls/446

Additional information

This is a PR to implement a solution for adding support for developers to have an the choice to see when user goes into full full screen and back again.

Note for Maintainers: If you see a need for a name change please go ahead and edit. Names are important. I have no opinion on naming of classes/functions/variables. If you see a need for them to change feel free to make those edits.

This commit introduces full screen state management for media elements. The `CommunityToolkit.Maui.Primitives` namespace was added to several files to support this feature. A new `MediaElementScreenState` enum and `FullScreenStateChangedEventArgs` class were added to represent the full screen state and event data respectively. The `IMediaElement` and `MediaElement` interfaces were updated to include a `FullScreenState` property, a `FullScreenStateChanged` event, and a `FullScreenChanged` method. The `MediaElementPage` class now subscribes to the `FullScreenStateChanged` event and logs information when triggered. The `MauiMediaElement` classes for Android and Windows, and the `MediaManagerDelegate` class for MacOS, were updated to include a `WindowsChanged` event that triggers when the full screen state changes. The `MediaManager` classes for Android, MacOS, and Windows now subscribe to the `WindowsChanged` event and update the full screen state when triggered. The `MediaManager` class for MacOS sets the `Delegate` property of the `AVPlayerViewController` to a new instance of `MediaManagerDelegate`.

- Updated MediaElementPage.xaml to include a new event handler `FullScreenStateChanged` for better responsiveness to fullscreen changes. - Removed subscription to `FullScreenStateChanged` in MediaElementPage.xaml.cs, indicating a shift in how fullscreen changes are managed. - Improved Android fullscreen support in MauiMediaElement.android.cs by invoking `OnWindowsChanged` with `FullScreenStateChangedEventArgs` to accurately track fullscreen state changes.

Updated the comment for the `OnWindowsChanged` static event in the `MediaManager` class to more accurately describe its purpose related to changes in the full screen state of the media element. The previous, less descriptive comment was replaced with a clearer explanation.

…iOld into FullScreenEvents

This commit overhauls the handling of full-screen state changes across Android, Windows, and macOS within a Maui application. A new record, `FullScreenEvents`, has been introduced in the `MediaManager` class to centralize event handling, replacing platform-specific `WindowsChanged` events with a unified approach. This refactor includes the removal of redundant `using` directives, adjustments in event invocation to utilize the new centralized event, and general code cleanup for better readability and maintainability. Platform-specific code has been updated to align with this new mechanism, streamlining the full-screen state change process across different operating systems.

…iOld into FullScreenEvents

- Removed `OnWindowsChanged` from `MediaManager` in platform-specific files (Android, macOS, Windows) due to redundancy and centralized this logic by adding a new protected method `OnWindowsChanged` to the `FullScreenEvents` record in `MediaManager.shared.cs`. This change aims to reduce code duplication and improve the management of full-screen state changes across different platforms.

Centralized the subscription to FullScreenEvents.WindowsChanged in the MediaManager class to improve maintainability and readability. Removed redundant event unsubscriptions in platform-specific MediaManager files, streamlining event management.

- Renamed `OnWindowsChanged` to `OnFullScreenStatusChanged` in `MediaManager` and `FullScreenEvents` for clarity. - Added `MediaElement` property to `FullScreenEvents` for better media element access.

In `MauiMediaElement.android.cs`, the visibility of `CurrentPlatformContext` has been changed from `readonly` to `public readonly`, enhancing its accessibility for external use. Additionally, in `MediaManager.shared.cs`, a comment has been added to acknowledge similarities with PR CommunityToolkit#1918 on the CommunityToolkit/Maui repository.

- Changed `CurrentPlatformContext` in `MauiMediaElement.android.cs` from `public` to `internal`, limiting its accessibility to within its assembly. - Modified `FullScreenEvents` in `MediaManager.shared.cs`: 1. Access modifier updated from `public` to `internal`. 2. Converted from a `record` to a `readonly record struct`, making it a value type and immutable.

Neotrickster · 2025-09-05T15:34:00Z

Hi @ne0rrmatrix , do you have any idea if this still need something to be in MedieElement ?

ne0rrmatrix · 2025-09-05T15:50:46Z

Hi @ne0rrmatrix , do you have any idea if this still need something to be in MedieElement ?

I am unable to move forward at this time. I do not understand what I should use for a name as @VladislavAntonyuk requested. I hope someone can suggest something. So far I have heard nothing from anyone.

ne0rrmatrix · 2025-09-05T19:08:15Z

@bijington ty for helping me figure out what I missed. I have updated the PR to address the naming issue.

src/CommunityToolkit.Maui.MediaElement/Primitives/FullScreenStateChangedEventArgs.cs

src/CommunityToolkit.Maui.MediaElement/Primitives/FullScreenEvents.cs

… event handling.

ne0rrmatrix · 2025-09-05T20:36:32Z

I have removed public static event handling and it now is much more compliant with our standards.

Copilot

Pull Request Overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.

Copilot · 2025-11-20T12:27:01Z

src/CommunityToolkit.Maui.MediaElement/Primitives/MediaElementFullScreenState.cs

+public enum MediaElementScreenState
+{
+	/// <summary>
+	/// Full screen.
+	/// </summary>
+	FullScreen,
+
+	/// <summary>
+	/// The default state.
+	/// </summary>
+	Default,
+}


According to the coding guidelines, enums should have values assigned (0, 1, 2, 3) if not marked with a Flags attribute. Additionally, the enum ordering doesn't follow the guideline: for return types that may have an unknown value, use Unknown at index 0; for option types that can use the system default, use Default at index 0.

Since this represents a screen state where Default is the standard (non-fullscreen) state, it should be at index 0. Suggested fix:

public enum MediaElementScreenState { /// <summary> /// The default state. /// </summary> Default = 0, /// <summary> /// Full screen. /// </summary> FullScreen = 1, }

Copilot · 2025-11-20T12:27:02Z

src/CommunityToolkit.Maui.MediaElement/Primitives/FullScreenStateChangedEventArgs.cs

+/// <param name="previousState"></param>
+/// <param name="newState"></param>


Missing documentation for the previousState and newState parameters. The parameter documentation should describe what these parameters represent. For example:

/// <param name="previousState">The previous full screen state.</param> /// <param name="newState">The new full screen state.</param>

Suggested change

/// <param name="previousState"></param>

/// <param name="newState"></param>

/// <param name="previousState">The previous full screen state.</param>

/// <param name="newState">The new full screen state.</param>

Copilot · 2025-11-20T12:27:02Z

src/CommunityToolkit.Maui.MediaElement/Interfaces/IMediaElement.shared.cs

+	/// <summary>
+	/// Triggers a <see cref="FullScreenState"/> change.
+	/// </summary>
+	/// <param name="newState"></param>


Missing documentation for the newState parameter. It should describe what the parameter represents. For example:

/// <param name="newState">The new full screen state to update to.</param>

Suggested change

/// <param name="newState"></param>

/// <param name="newState">The new full screen state to update to.</param>

Copilot · 2025-11-20T12:27:03Z

src/CommunityToolkit.Maui.MediaElement/Primitives/FullScreenStateChangedEventArgs.cs

+/// <param name="newState"></param>
+public sealed class FullScreenStateChangedEventArgs(MediaElementScreenState previousState, MediaElementScreenState newState) : EventArgs
+{
+


[nitpick] There's an extra blank line here. According to coding style best practices, there should be consistent spacing. This blank line should be removed.

Suggested change

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

Copilot · 2025-11-24T04:26:05Z

src/CommunityToolkit.Maui.MediaElement/Views/MediaManager.macios.cs

+	public override void WillBeginFullScreenPresentation(AVPlayerViewController playerViewController, IUIViewControllerTransitionCoordinator coordinator)
+	{
+		mediaManager.UpdateFullScreenState(MediaElementScreenState.FullScreen);
+	}


[nitpick] Missing blank line between methods. For consistency and readability, consider adding a blank line between the WillBeginFullScreenPresentation and WillEndFullScreenPresentation methods.

Suggested change

}

}

Copilot · 2025-11-24T04:26:06Z

src/CommunityToolkit.Maui.MediaElement/Views/MauiMediaElement.android.cs

 	/// <param name="context">The application's <see cref="Context"/>.</param>
 	/// <param name="playerView">The <see cref="PlayerView"/> that acts as the platform media player.</param>
-	public MauiMediaElement(Context context, PlayerView playerView) : base(context)
+	/// <param name="mediaManager">The <see cref="mediaManager"/> that is managing the <see cref="MediaElement"/> instance.</param>


The XML documentation has an incorrect <see cref> reference. It should reference MediaManager (the type) rather than just mediaManager (the parameter name).

Suggested fix:

/// <param name="mediaManager">The <see cref="MediaManager"/> that is managing the <see cref="MediaElement"/> instance.</param>

Suggested change

/// <param name="mediaManager">The <see cref="mediaManager"/> that is managing the <see cref="MediaElement"/> instance.</param>

/// <param name="mediaManager">The <see cref="MediaManager"/> that is managing the <see cref="MediaElement"/> instance.</param>

ne0rrmatrix added 23 commits May 24, 2024 08:10

Merge Main into FullScreenEvents

2aaa53e

fix merge bug

6db6b06

fix fullscreen event handling macios

7669d0a

Merge branch 'CommunityToolkit:main' into FullScreenEvents

2783077

Merge branch 'CommunityToolkit:main' into FullScreenEvents

47b6434

Merge Main into FullScreenEvents

5185222

fix merge errror

8198c94

Fix another merge error

6d34192

Merge branch 'FullScreenEvents' of https://github.com/ne0rrmatrix/Mau…

d7c12eb

…iOld into FullScreenEvents

Merge branch 'CommunityToolkit:main' into FullScreenEvents

afa937f

Merge branch 'FullScreenEvents' of https://github.com/ne0rrmatrix/Mau…

697950d

…iOld into FullScreenEvents

fix spacing issue

5706688

Centralize FullScreenEvents subscription

4a12906

Centralized the subscription to FullScreenEvents.WindowsChanged in the MediaManager class to improve maintainability and readability. Removed redundant event unsubscriptions in platform-specific MediaManager files, streamlining event management.

fix cosmetic issues

3425c25

More Cosmetic Fixes

7f75702

Refactor full screen event handling

8bfed07

- Renamed `OnWindowsChanged` to `OnFullScreenStatusChanged` in `MediaManager` and `FullScreenEvents` for clarity. - Added `MediaElement` property to `FullScreenEvents` for better media element access.

This was referenced Jul 19, 2024

[BUG] MediaElement Android crashes when OnFullscreenButtonClick #2044

Closed

Full Screen Events MicrosoftDocs/CommunityToolkit#446

Draft

ne0rrmatrix and others added 4 commits July 21, 2024 19:13

Merge branch 'main' into FullScreenEvents

4abb02c

Merge branch 'main' into FullScreenEvents

63bf581

Merge branch 'main' into FullScreenEvents

b43ccfa

Merge branch 'main' into FullScreenEvents

f1c1ae6

ne0rrmatrix added the needs discussion Discuss it on the next Monthly standup label Jul 30, 2024

ne0rrmatrix added the needs discussion Discuss it on the next Monthly standup label Jul 30, 2025

Merge branch 'main' into FullScreenEvents

eba43a3

dotnet-policy-service bot added stale The author has not responded in over 30 days help wanted This proposal has been approved and is ready to be implemented labels Sep 4, 2025

Merge branch 'main' into FullScreenEvents

726a54b

Fix variable case

5a5675c

ne0rrmatrix dismissed VladislavAntonyuk’s stale review via 5a5675c September 5, 2025 19:06

pictos reviewed Sep 5, 2025

View reviewed changes

src/CommunityToolkit.Maui.MediaElement/Primitives/FullScreenStateChangedEventArgs.cs Outdated Show resolved Hide resolved

src/CommunityToolkit.Maui.MediaElement/Primitives/FullScreenEvents.cs Outdated Show resolved Hide resolved

ne0rrmatrix added 2 commits September 5, 2025 12:51

Update FullScreenEvents to use WeakEventManager

427e31f

Removed public static event and FullScreenEvents. Updated with better…

eee4a19

… event handling.

ne0rrmatrix added 2 commits September 5, 2025 13:41

Updated FullScreenStateChangedEventArgs to inherit from EventArgs

073a2bd

Merge branch 'main' into FullScreenEvents

79210ce

TheCodeTraveler marked this pull request as draft October 2, 2025 19:33

ne0rrmatrix added 3 commits October 16, 2025 16:08

Merge branch 'main' into FullScreenEvents

37cd87a

Merge branch 'main' into FullScreenEvents

8aef539

Merge branch 'main' into FullScreenEvents

dfb8233

Copilot AI review requested due to automatic review settings November 20, 2025 12:21

Copilot started reviewing on behalf of ne0rrmatrix November 20, 2025 12:22 View session

Copilot finished reviewing on behalf of ne0rrmatrix November 20, 2025 12:24

Copilot AI reviewed Nov 20, 2025

View reviewed changes

ne0rrmatrix added 2 commits November 23, 2025 01:17

Merge branch 'main' into FullScreenEvents

c04ee86

Merge branch 'main' into FullScreenEvents

fb4ec2c

Copilot AI review requested due to automatic review settings November 24, 2025 04:21

Copilot started reviewing on behalf of ne0rrmatrix November 24, 2025 04:21 View session

Copilot finished reviewing on behalf of ne0rrmatrix November 24, 2025 04:24

Copilot AI reviewed Nov 24, 2025

View reviewed changes

		/// <param name="previousState"></param>
		/// <param name="newState"></param>

	/// <param name="newState"></param>
	/// <param name="newState">The new full screen state to update to.</param>

	/// <param name="mediaManager">The <see cref="mediaManager"/> that is managing the <see cref="MediaElement"/> instance.</param>
	/// <param name="mediaManager">The <see cref="MediaManager"/> that is managing the <see cref="MediaElement"/> instance.</param>

Full screen events #2041

Are you sure you want to change the base?

Full screen events #2041

Uh oh!

Conversation

ne0rrmatrix commented Jul 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Linked Issues

PR Checklist

Additional information

Uh oh!

Neotrickster commented Sep 5, 2025

Uh oh!

ne0rrmatrix commented Sep 5, 2025

Uh oh!

ne0rrmatrix commented Sep 5, 2025

Uh oh!

Uh oh!

Uh oh!

ne0rrmatrix commented Sep 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Nov 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 24, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ne0rrmatrix commented Jul 19, 2024 •

edited

Loading