Skip to content

Enhancements: Start Time Initialization and Extended Volume Range #451

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.

Sign up for GitHub

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Enhancements: Start Time Initialization and Extended Volume Range #451

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
769fa43
setMaxVolume and startAt when changing media
itsSagarBro Nov 7, 2023
de94ba2
get max volume
itsSagarBro Nov 7, 2023
36b2b8a
fix
itsSagarBro Nov 7, 2023
f59d0cd
Fixes.
itsSagarBro Dec 9, 2023
c0c3e60
Merge branch 'solid-software:master' into master
itsSagarBro Apr 23, 2025
03e8d54
Errors Resolved
ksbmsagar Apr 23, 2025
480eddd
Merge branch 'solid-software:master' into master
itsSagarBro May 31, 2025
bc37187
Fixes
itsSagarBro May 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...er_vlc_player/android/src/main/java/software/solid/fluttervlcplayer/FlutterVlcPlayer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ void setLooping(boolean value) {
void setVolume(long value) {
if (mediaPlayer == null) return;

long bracketedValue = Math.max(0, Math.min(100, value));
long bracketedValue = Math.max(0, Math.min(200, value));
mediaPlayer.setVolume((int) bracketedValue);
}

Expand Down
76 changes: 73 additions & 3 deletions flutter_vlc_player/lib/src/vlc_player_controller.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ import 'package:flutter_vlc_player_platform_interface/flutter_vlc_player_platfor
///
/// After [dispose] all further calls are ignored.
class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
static const _maxVolume = 100;
int _maxVolume = 100;
bool _startAtSet = false;

/// The URI to the video file. This will be in different formats depending on
/// the [DataSourceType] of the original video.
Expand All @@ -39,6 +40,9 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
/// Initialize vlc player when the platform is ready automatically
final bool autoInitialize;

/// Video start from [startAt]. When initialization is complete
final Duration? startAt;

/// Set keep playing video in background, when app goes in background.
/// The default value is false.
final bool allowBackgroundPlayback;
Expand Down Expand Up @@ -71,7 +75,6 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {

/// List of onRenderer listeners
final List<RendererCallback> _onRendererEventListeners = [];

bool _isDisposed = false;

VlcAppLifeCycleObserver? _lifeCycleObserver;
Expand All @@ -96,6 +99,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
this.dataSource, {
this.autoInitialize = true,
this.allowBackgroundPlayback = false,
this.startAt,
this.package,
this.hwAcc = HwAcc.auto,
this.autoPlay = true,
Expand All @@ -118,6 +122,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
this.dataSource, {
this.autoInitialize = true,
this.allowBackgroundPlayback = false,
this.startAt,
this.hwAcc = HwAcc.auto,
this.autoPlay = true,
this.options,
Expand All @@ -139,6 +144,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
File file, {
this.autoInitialize = true,
this.allowBackgroundPlayback = true,
this.startAt,
this.hwAcc = HwAcc.auto,
this.autoPlay = true,
this.options,
Expand Down Expand Up @@ -233,6 +239,10 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
);
break;
case VlcMediaEventType.playing:

/// Calling start at
if (startAt != null && !_startAtSet) _setStartAt();

value = value.copyWith(
isEnded: false,
isPlaying: true,
Expand Down Expand Up @@ -349,6 +359,26 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
return initializingCompleter.future;
}

/// Seeking to start at
Future<void> _setStartAt() async {
// Check if already seted up or start at is null then return.
if (startAt == null || _startAtSet) return;

final Duration startAtDuration = startAt ?? Duration.zero;

// Checking if startAt is greatet then video's duration then throw error.
if (startAtDuration.inMilliseconds > value.duration.inMilliseconds) {
throw ArgumentError.value(
startAtDuration,
'Start At cannot be greater than video duration.',
);
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

There are a couple of points regarding the _setStartAt method logic here:

  1. Nullable startAt Assignment (Minor): On line 358, startAtDuration is assigned using startAt ?? Duration.zero. However, the check on line 356 (if (startAt == null || _startAtSet) return;) ensures that startAt (which refers to this.startAt from the constructor) is not null if the function proceeds to this point. Using startAt! would be more direct and reflect this guarantee: final Duration startAtDuration = startAt!;.

  2. Duration Check Robustness (Main Point): The check on lines 361-365 (if (startAtDuration.inMilliseconds > value.duration.inMilliseconds)) will throw an ArgumentError. This is problematic if value.duration is Duration.zero (e.g., for live streams, or if duration metadata isn't immediately available when the playing event fires) while startAtDuration is positive. This could unnecessarily prevent the startAt feature from working in these scenarios.

    To make this more robust, consider only throwing the error if value.duration is known (i.e., non-zero) and startAtDuration exceeds it. If value.duration is zero, it might be better to proceed with the seekTo call and let the underlying player handle the seek attempt. This would allow startAt to function even if the duration is temporarily unknown.

    Here's a suggested modification incorporating both points:

    // In _setStartAt()
final Duration startAtDuration = startAt!; // Point 1 addressed

// Only perform the check if the video's duration is known (greater than zero)
if (value.duration > Duration.zero && 
    startAtDuration.inMilliseconds > value.duration.inMilliseconds) {
  throw ArgumentError.value(
    startAtDuration,
    'Start At cannot be greater than video duration.',
  );
}
// ... rest of the method ...

    This change allows the seek to be attempted if the duration is initially unknown, potentially improving the reliability of the startAt feature.

    final Duration startAtDuration = startAt!;

    // Checking if startAt is greatet then video's duration then throw error.
    // Only throw if duration is known (non-zero) and startAt exceeds it.
    if (value.duration > Duration.zero && 
        startAtDuration.inMilliseconds > value.duration.inMilliseconds) {
      throw ArgumentError.value(
        startAtDuration,
        'Start At cannot be greater than video duration.',
      );
    }

}

// Setting startAt
_startAtSet = true;
await seekTo(startAtDuration);
}

/// Dispose controller
@override
Future<void> dispose() async {
Expand Down Expand Up @@ -394,6 +424,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
String? package,
bool? autoPlay,
HwAcc? hwAcc,
Duration? startAt,
}) async {
_dataSourceType = DataSourceType.asset;
this.package = package;
Expand All @@ -403,6 +434,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
package: package,
autoPlay: autoPlay,
hwAcc: hwAcc,
startAt: startAt,
);
}

Expand All @@ -414,6 +446,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
String dataSource, {
bool? autoPlay,
HwAcc? hwAcc,
Duration? startAt,
}) async {
_dataSourceType = DataSourceType.network;
package = null;
Expand All @@ -422,6 +455,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
dataSourceType: DataSourceType.network,
autoPlay: autoPlay,
hwAcc: hwAcc,
startAt: startAt,
);
}

Expand All @@ -433,6 +467,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
File file, {
bool? autoPlay,
HwAcc? hwAcc,
Duration? startAt,
}) async {
_dataSourceType = DataSourceType.file;
package = null;
Expand All @@ -442,6 +477,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
dataSourceType: DataSourceType.file,
autoPlay: autoPlay,
hwAcc: hwAcc,
startAt: startAt,
);
}

Expand All @@ -456,6 +492,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
String? package,
bool? autoPlay,
HwAcc? hwAcc,
Duration? startAt,
}) async {
_throwIfNotInitialized('setStreamUrl');
await vlcPlayerPlatform.stop(_viewId);
Expand All @@ -468,6 +505,10 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
autoPlay: autoPlay ?? true,
);

if (startAt != null) {
await vlcPlayerPlatform.seekTo(_viewId, startAt);
}

return;
}

Expand Down Expand Up @@ -557,9 +598,38 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
return position;
}

/// Sets the max audio volume of
///
/// [maxVolume] indicates a value between 1 (lowest) and 200 (highest) on a
/// linear scale.
Future<void> setMaxVolume(int maxVolume) async {
_throwIfNotInitialized('setMaxVolume');
if (maxVolume > 200) {
throw ArgumentError.value(
maxVolume,
'Max volume should be lower than 200.',
);
} else if (maxVolume <= 0) {
throw ArgumentError.value(
maxVolume,
'Max volume should not be 0 or negative.',
);
}
_maxVolume = maxVolume;

return;
}

/// Returns current vlc max volume level.
Future<int> getMaxVolume() async {
_throwIfNotInitialized('getMaxVolume');

return _maxVolume;
}

/// Sets the audio volume of
///
/// [volume] indicates a value between 0 (silent) and 100 (full volume) on a
/// [volume] indicates a value between 0 (silent), 100 (full volume) and 200 (maximum) on a
/// linear scale.
Future<void> setVolume(int volume) async {
_throwIfNotInitialized('setVolume');
Expand Down