Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full screen events #2041

Open
wants to merge 60 commits into
base: main
Choose a base branch
from

Conversation

ne0rrmatrix
Copy link
Contributor

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

/// <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

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
@cvazquez08
Copy link

+1 to merge this in 😄

@ne0rrmatrix - Any plans to merge this in?

@brminnick brminnick removed the needs discussion Discuss it on the next Monthly standup label Sep 5, 2024
@ne0rrmatrix
Copy link
Contributor Author

+1 to merge this in 😄

@ne0rrmatrix - Any plans to merge this in?

Yes it will be merged some time in the future. I am working on porting Media 3 and after it is done I will be getting back to this PR and a few others and making sure they are GTG and waiting on review after that. All my PR's are essentially on hold waiting for media3. Media 3 is the new home of Exoplayer and will allow us to not be on a deprecated library anymore. It is near to being ready and all the bugs have been fixed.

ATM the nugets are not ready for us. I have One PR waiting for approval. That will fix at least one show stopper bug in media 3 bindings. The current bindings also have a show stopper bug that was fixed by me in another PR that has been merged.

It will be another few weeks to maybe a month before it will be ready for review. Fingers crossed it may be merge in October if we are super lucky. Most likely November. Following that I will be looking back at this PR and others to make sure they are fine and then I will bug the team to review them.

@ne0rrmatrix
Copy link
Contributor Author

+1 to merge this in 😄

@ne0rrmatrix - Any plans to merge this in?

This will be looked at after #2076 has merged

@cvazquez08
Copy link

+1 to merge this in 😄

@ne0rrmatrix - Any plans to merge this in?

This will be looked at after #2076 has merged

Thank you!

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 10 changed files in this pull request and generated no suggestions.

Files not reviewed (5)
  • samples/CommunityToolkit.Maui.Sample/Pages/Views/MediaElement/MediaElementPage.xaml: Language not supported
  • samples/CommunityToolkit.Maui.Sample/Pages/Views/MediaElement/MediaElementPage.xaml.cs: Evaluated as low risk
  • src/CommunityToolkit.Maui.MediaElement/Interfaces/IMediaElement.cs: Evaluated as low risk
  • src/CommunityToolkit.Maui.MediaElement/MediaElement.shared.cs: Evaluated as low risk
  • src/CommunityToolkit.Maui.MediaElement/Primitives/FullScreenStateChangedEventArgs.cs: Evaluated as low risk
Comments skipped due to low confidence (3)

src/CommunityToolkit.Maui.MediaElement/Views/MediaManager.shared.cs:57

  • [nitpick] The method name 'OnWindowsChanged' is misleading as it suggests it is specific to Windows. Consider renaming it to 'OnFullScreenStateChanged' to clearly indicate its purpose.
public static void OnWindowsChanged(FullScreenStateChangedEventArgs e) => WindowsChanged?.Invoke(null, e);

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

  • [nitpick] Consider marking the CurrentPlatformContext struct as sealed instead of readonly to prevent inheritance and ensure immutability.
readonly record struct CurrentPlatformContext

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

  • The summary comments for the enum values should be more descriptive to provide better context for developers.
/// 
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📽️ MediaElement Issue/PR that has to do with MediaElement
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.
3 participants