Skip to content

Full screen events#2041

Open
ne0rrmatrix wants to merge 141 commits intoCommunityToolkit:mainfrom
ne0rrmatrix:FullScreenEvents
Open

Full screen events#2041
ne0rrmatrix wants to merge 141 commits intoCommunityToolkit:mainfrom
ne0rrmatrix:FullScreenEvents

Conversation

@ne0rrmatrix
Copy link
Member

@ne0rrmatrix ne0rrmatrix commented Jul 19, 2024

  • 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:

static readonly BindablePropertyKey screenStatePropertyKey =
	BindableProperty.CreateReadOnly(nameof(FullScreenState), typeof(MediaElementScreenState), typeof(MediaElement),
		MediaElementScreenState.Default, propertyChanged: OnFullScreenPropertyChanged);
/// <summary>
/// Backing store for the <see cref="FullScreenState"/> property.
/// </summary>
public static readonly BindableProperty ScreenStateProperty = screenStatePropertyKey.BindableProperty;

/// <summary>
/// Gets the full screen state of the media element.
/// </summary>
public MediaElementScreenState ScreenState
{
      get => (MediaElementScreenState)GetValue(ScreenStateProperty);
      private set => SetValue(screenStatePropertyKey, 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

PR Checklist

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.
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.
- 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.
@ne0rrmatrix ne0rrmatrix added the needs discussion Discuss it on the next Monthly standup label Jul 30, 2024
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

Renamed the FullScreenButtonClicked event to FullScreenStateChanged across Android, Windows, and iOS/macOS MediaElement implementations. Updated all event declarations, handler subscriptions, and invocations for consistency and clarity. Also renamed related variables (e.g., mDelegate to fullScreenDelegate) to match the new event naming. This change ensures the event accurately represents any full-screen state change, not just button clicks.
Copilot AI review requested due to automatic review settings February 17, 2026 17:46
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

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

ne0rrmatrix and others added 2 commits February 17, 2026 10:06
Refactored all usages of FullScreenStateChanged event and related types to ScreenStateChanged for improved clarity and generalization. Replaced FullScreenStateChangedEventArgs with ScreenStateChangedEventArgs, updated property and field names, and revised event handler signatures and XAML wiring across all platforms. Updated unit tests to reflect these changes. This makes screen state transitions more semantically accurate and extensible beyond just full screen scenarios.
…hangedEventArgs.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 17, 2026 18:21
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 8 comments.

…windows.cs

Co-authored-by: Pedro Jesus <pedrojesus.cefet@gmail.com>
Copilot AI review requested due to automatic review settings February 18, 2026 02:25
ne0rrmatrix and others added 4 commits February 17, 2026 18:26
…os.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ndler.windows.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ows.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ndler.windows.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

…ementTests.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 18, 2026 02:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.

Renamed the FullScreenState property and all related references
to ScreenState across the codebase. This includes property
names, event documentation, method parameters, and all usages
in implementation and tests. The change generalizes the state
property to better reflect its purpose and potential future use
cases beyond just fullscreen.
Simplified fullscreen toggle logic by removing unnecessary null
checks and direct use of the nullable Value property. Assumes
mediaElementState is always set, improving code clarity.
Copilot AI review requested due to automatic review settings February 18, 2026 03:25
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

help wanted This proposal has been approved and is ready to be implemented 📽️ MediaElement Issue/PR that has to do with MediaElement needs discussion Discuss it on the next Monthly standup stale The author has not responded in over 30 days

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

8 participants