Skip to content

[camera] Deprecate maxDuration in platform interface #7078

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

Merged
merged 9 commits into from
Jul 9, 2024
Merged

[camera] Deprecate maxDuration in platform interface #7078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c7e4c51
[camera] Clean up partial maxVideoDuration code
stuartmorgan-g Jul 1, 2024
2b4562b
Minor fixup
stuartmorgan-g Jul 1, 2024
0f96c85
Test fixes
stuartmorgan-g Jul 1, 2024
5b7df77
Test expectation cleanup
stuartmorgan-g Jul 2, 2024
2a2b169
Windows fixes
stuartmorgan-g Jul 2, 2024
7621a68
Fix iOS version
stuartmorgan-g Jul 2, 2024
8988fde
Merge branch 'main' into camera-max-duration-unwind
stuartmorgan-g Jul 2, 2024
18d94d8
Revert everything but platform interface
stuartmorgan-g Jul 8, 2024
7d794c9
Merge branch 'main' into camera-max-duration-unwind-platform-interface
stuartmorgan-g Jul 8, 2024
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
4 changes: 3 additions & 1 deletion packages/camera/camera_platform_interface/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## NEXT
## 2.8.0

* Deprecates `maxVideoDuration`/`maxDuration`, as it was never implemented on
most platforms, and there is no plan to implement it in the future.
* Updates minimum supported SDK version to Flutter 3.16/Dart 3.2.

## 2.7.4
Expand Down
16 changes: 7 additions & 9 deletions packages/camera/camera_platform_interface/lib/src/platform_interface/camera_platform.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,14 +140,13 @@ abstract class CameraPlatform extends PlatformInterface {

/// Starts a video recording.
///
/// The length of the recording can be limited by specifying the [maxVideoDuration].
/// By default no maximum duration is specified,
/// meaning the recording will continue until manually stopped.
/// With [maxVideoDuration] set the video is returned in a [VideoRecordedEvent]
/// through the [onVideoRecordedEvent] stream when the set duration is reached.
///
/// This method is deprecated in favour of [startVideoCapturing].
Future<void> startVideoRecording(int cameraId, {Duration? maxVideoDuration}) {
Future<void> startVideoRecording(
int cameraId, {
@Deprecated(
'This parameter is unused, and will be ignored on all platforms')
Duration? maxVideoDuration,
}) {
throw UnimplementedError('startVideoRecording() is not implemented.');
}

Expand All @@ -156,8 +155,7 @@ abstract class CameraPlatform extends PlatformInterface {
/// Please see [VideoCaptureOptions] for documentation on the
/// configuration options.
Future<void> startVideoCapturing(VideoCaptureOptions options) {
return startVideoRecording(options.cameraId,
maxVideoDuration: options.maxDuration);
return startVideoRecording(options.cameraId);
}

/// Stops the video recording and returns the file where it was saved.
Expand Down
7 changes: 5 additions & 2 deletions packages/camera/camera_platform_interface/lib/src/types/video_capture_options.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ class VideoCaptureOptions {
/// Constructs a new instance.
const VideoCaptureOptions(
this.cameraId, {
@Deprecated(
'This parameter is unused, and will be ignored on all platforms')
this.maxDuration,
this.streamCallback,
this.streamOptions,
Expand All @@ -24,8 +26,9 @@ class VideoCaptureOptions {
final int cameraId;

/// The maximum time to perform capturing for.
///
/// By default there is no maximum on the capture time.
@Deprecated('This parameter is unused, and will be ignored on all platforms')
// Platform implementations should not implement this, as it will never be
// passed from the app-facing layer.
final Duration? maxDuration;

/// An optional callback to enable streaming.
Expand Down
2 changes: 1 addition & 1 deletion packages/camera/camera_platform_interface/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ repository: https://github.com/flutter/packages/tree/main/packages/camera/camera
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
# NOTE: We strongly prefer non-breaking changes, even at the expense of a
# less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
version: 2.7.4
version: 2.8.0

environment:
sdk: ^3.2.0
Expand Down
24 changes: 0 additions & 24 deletions ...ages/camera/camera_platform_interface/test/method_channel/method_channel_camera_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,30 +643,6 @@ void main() {
]);
});

test('Should pass maxVideoDuration when starting recording a video',
() async {
// Arrange
final MethodChannelMock channel = MethodChannelMock(
channelName: 'plugins.flutter.io/camera',
methods: <String, dynamic>{'startVideoRecording': null},
);

// Act
await camera.startVideoRecording(
cameraId,
maxVideoDuration: const Duration(seconds: 10),
);

// Assert
expect(channel.log, <Matcher>[
isMethodCall('startVideoRecording', arguments: <String, Object?>{
'cameraId': cameraId,
'maxVideoDuration': 10000,
'enableStream': false,
}),
]);
});

test('Should stop a video recording and return the file', () async {
// Arrange
final MethodChannelMock channel = MethodChannelMock(
Expand Down