@@ -0,0 +1,152 @@ /* * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * See the NOTICE file distributed with this work for additional * information regarding copyright ownership. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */
package io.appium.java_client.mac;
import com.google.common.collect.ImmutableMap; import io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions;
import java.time.Duration; import java.util.Map;
import static java.util.Optional.ofNullable;
public class Mac2StartScreenRecordingOptions extends BaseStartScreenRecordingOptions<Mac2StartScreenRecordingOptions> { private Integer fps; private String videoFilter; private String preset; private Boolean captureCursor; private Boolean captureClicks; private Integer deviceId;
public static Mac2StartScreenRecordingOptions startScreenRecordingOptions() { return new Mac2StartScreenRecordingOptions(); }
/** * The count of frames per second in the resulting video. * Increasing fps value also increases the size of the resulting * video file and the CPU usage. * * @param fps The actual frames per second value. * The default value is 15. * @return self instance for chaining. */ public Mac2StartScreenRecordingOptions withFps(int fps) { this.fps = fps; return this; }
/** * Whether to capture the mouse cursor while recording * the screen. Disabled by default. * * @return self instance for chaining. */ public Mac2StartScreenRecordingOptions enableCursorCapture() { this.captureCursor = true; return this; }
/** * Whether to capture the click gestures while recording * the screen. Disabled by default. * * @return self instance for chaining. */ public Mac2StartScreenRecordingOptions enableClicksCapture() { this.captureClicks = true; return this; }
/** * Screen device index to use for the recording. * The list of available devices could be retrieved using * `ffmpeg -f avfoundation -list_devices true -i` command. * This option is mandatory and must be always provided. * * @param deviceId The valid screen device identifier. * @return self instance for chaining. */ public Mac2StartScreenRecordingOptions withDeviceId(Integer deviceId) { this.deviceId = deviceId; return this; }
/** * The video filter spec to apply for ffmpeg. * See https://trac.ffmpeg.org/wiki/FilteringGuide for more details on the possible values. * Example: Set it to `scale=ifnot(gte(iw\,1024)\,iw\,1024):-2` in order to limit the video width * to 1024px. The height will be adjusted automatically to match the actual screen aspect ratio. * * @param videoFilter Valid ffmpeg video filter spec string. * @return self instance for chaining. */ public Mac2StartScreenRecordingOptions withVideoFilter(String videoFilter) { this.videoFilter = videoFilter; return this; }
/** * A preset is a collection of options that will provide a certain encoding speed to compression ratio. * A slower preset will provide better compression (compression is quality per filesize). * This means that, for example, if you target a certain file size or constant bit rate, you will * achieve better quality with a slower preset. Read https://trac.ffmpeg.org/wiki/Encode/H.264 * for more details. * * @param preset One of the supported encoding presets. Possible values are: * - ultrafast * - superfast * - veryfast (default) * - faster * - fast * - medium * - slow * - slower * - veryslow * @return self instance for chaining. */ public Mac2StartScreenRecordingOptions withPreset(String preset) { this.preset = preset; return this; }
/** * The maximum recording time. The default value is 600 seconds (10 minutes). * The minimum time resolution unit is one second. * * @param timeLimit The actual time limit of the recorded video. * @return self instance for chaining. */ @Override public Mac2StartScreenRecordingOptions withTimeLimit(Duration timeLimit) { return super.withTimeLimit(timeLimit); }
@Override public Map<String, Object> build() { final ImmutableMap.Builder<String, Object> builder = ImmutableMap.builder(); builder.putAll(super.build()); ofNullable(fps).map(x -> builder.put("fps", x)); ofNullable(preset).map(x -> builder.put("preset", x)); ofNullable(videoFilter).map(x -> builder.put("videoFilter", x)); ofNullable(captureClicks).map(x -> builder.put("captureClicks", x)); ofNullable(captureCursor).map(x -> builder.put("captureCursor", x)); ofNullable(deviceId).map(x -> builder.put("deviceId", x)); return builder.build(); } }