Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import io.appium.java_client.AppiumDriver;
import io.appium.java_client.FindsByWindowsAutomation;
import io.appium.java_client.HidesKeyboardWithKeyName;
import io.appium.java_client.screenrecording.CanRecordScreen;
import io.appium.java_client.service.local.AppiumDriverLocalService;
import io.appium.java_client.service.local.AppiumServiceBuilder;
import org.openqa.selenium.Capabilities;
Expand All @@ -32,7 +33,7 @@

public class WindowsDriver<T extends WebElement>
extends AppiumDriver<T> implements PressesKeyCode, HidesKeyboardWithKeyName,
FindsByWindowsAutomation<T> {
FindsByWindowsAutomation<T>, CanRecordScreen {

public WindowsDriver(HttpCommandExecutor executor, Capabilities capabilities) {
super(executor, updateDefaultPlatformName(capabilities, WINDOWS));
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
/*
* 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.windows;

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 WindowsStartScreenRecordingOptions
extends BaseStartScreenRecordingOptions<WindowsStartScreenRecordingOptions> {
private Integer fps;
private String videoFilter;
private String preset;
private Boolean captureCursor;
private Boolean captureClicks;
private String audioInput;

public static WindowsStartScreenRecordingOptions startScreenRecordingOptions() {
return new WindowsStartScreenRecordingOptions();
}

/**
* 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 WindowsStartScreenRecordingOptions 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 WindowsStartScreenRecordingOptions 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 WindowsStartScreenRecordingOptions enableClicksCapture() {
this.captureClicks = true;
return this;
}

/**
* If provided then the given audio input will be used to record the computer audio
* along with the desktop video. The list of available devices could be retrieved using
* `ffmpeg -list_devices true -f dshow -i dummy` command.
*
* @param audioInput One of valid audio input names listed by ffmpeg
* @return self instance for chaining.
*/
public WindowsStartScreenRecordingOptions withAudioInput(String audioInput) {
this.audioInput = audioInput;
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 WindowsStartScreenRecordingOptions 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 WindowsStartScreenRecordingOptions 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 WindowsStartScreenRecordingOptions 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(audioInput).map(x -> builder.put("audioInput", x));
return builder.build();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* 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.windows;

import io.appium.java_client.screenrecording.BaseStopScreenRecordingOptions;

public class WindowsStopScreenRecordingOptions extends
BaseStopScreenRecordingOptions<WindowsStopScreenRecordingOptions> {

public static WindowsStopScreenRecordingOptions stopScreenRecordingOptions() {
return new WindowsStopScreenRecordingOptions();
}

}