Skip to content

Commit 29fe7cd

Browse files
andrewjl-muxandrewjl-mux
authored
api: convert standardization enabled to standardization requested (#77)
A more accurate nomenclature for how input standardization actually works, it is not necessarily performed if requested, only if the SDK deems necessary * Update tests * Update API documentation * Input Standardization Disabled -> Skipped * Space
1 parent 40721e7 commit 29fe7cd

File tree

7 files changed

+30
-30
lines changed

7 files changed

+30
-30
lines changed

‎Sources/MuxUploadSDK/InternalUtilities/Reporting/Reporter.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ extension Reporter {
108108
deviceModel: device.model,
109109
inputDuration: inputDuration,
110110
inputSize: inputSize,
111-
inputStandardizationEnabled: options.inputStandardization.isEnabled,
111+
inputStandardizationRequested: options.inputStandardization.isRequested,
112112
platformName: device.systemName,
113113
platformVersion: device.systemVersion,
114114
regionCode: regionCode,
@@ -149,7 +149,7 @@ extension Reporter {
149149
errorDescription: errorDescription,
150150
inputDuration: inputDuration,
151151
inputSize: inputSize,
152-
inputStandardizationEnabled: options.inputStandardization.isEnabled,
152+
inputStandardizationRequested: options.inputStandardization.isRequested,
153153
platformName: device.systemName,
154154
platformVersion: device.systemVersion,
155155
regionCode: regionCode,

‎Sources/MuxUploadSDK/InternalUtilities/Reporting/UploadFailedEvent.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ struct UploadFailedEvent: Codable {
1717
var errorDescription: String
1818
var inputDuration: Double
1919
var inputSize: UInt64
20-
var inputStandardizationEnabled: Bool
20+
var inputStandardizationRequested: Bool
2121
var platformName: String
2222
var platformVersion: String
2323
var regionCode: String?

‎Sources/MuxUploadSDK/InternalUtilities/Reporting/UploadSucceededEvent.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ struct UploadSucceededEvent: Codable {
1919
var deviceModel: String
2020
var inputDuration: Double
2121
var inputSize: UInt64
22-
var inputStandardizationEnabled: Bool
22+
var inputStandardizationRequested: Bool
2323
var platformName: String
2424
var platformVersion: String
2525
var regionCode: String?

‎Sources/MuxUploadSDK/PublicAPI/MuxUpload.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public final class MuxUpload {
7777
/// Upload started by a call to ``MuxUpload.start(forceRestart:)``
7878
case started(AVAsset)
7979
/// Upload is being prepared for transport to the
80-
/// server. If input standardization was enabled,
80+
/// server. If input standardization was requested,
8181
/// this stage includes the inspection and standardization
8282
/// of input formats
8383
case preparing(AVAsset)
@@ -459,7 +459,7 @@ public final class MuxUpload {
459459
func startInspection(
460460
videoFile: URL
461461
) {
462-
if !uploadInfo.options.inputStandardization.isEnabled {
462+
if !uploadInfo.options.inputStandardization.isRequested {
463463
startNetworkTransport(videoFile: videoFile)
464464
} else {
465465
let inputStandardizationStartTime = Date()

‎Sources/MuxUploadSDK/PublicAPI/Options/UploadOptions.swift‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ public struct UploadOptions {
4242
/// Settings controlling direct upload input standardization
4343
public struct InputStandardization {
4444

45-
/// If enabled the SDK will attempt to detect
45+
/// If requested the SDK will attempt to detect
4646
/// non-standard input formats and if so detected
4747
/// will attempt to standardize to a standard input
4848
/// format. ``true`` by default
49-
public var isEnabled: Bool = true
49+
public var isRequested: Bool = true
5050

5151
/// Preset to control the resolution of the standard
5252
/// input.
@@ -75,7 +75,7 @@ public struct UploadOptions {
7575
/// no other non-standard input parameters with
7676
/// ``MaximumResolution.default`` selected.
7777
///
78-
/// If input standardization is enabled, the SDK
78+
/// If input standardization is requested, the SDK
7979
/// will attempt standardize the input into an H.264
8080
/// encoded output that will maintain its original
8181
/// 1440 x 1080 resolution.
@@ -85,40 +85,40 @@ public struct UploadOptions {
8585
/// non-standard input format parameters with
8686
/// ``MaximumResolution.preset1280x720`` selected.
8787
///
88-
/// If input standardization is enabled, the SDK
88+
/// If input standardization is requested, the SDK
8989
/// will attempt standardize the input into an H.264
9090
/// encoded output with a reduced 1280 x 720 resolution.
9191
///
9292
public var maximumResolution: MaximumResolution = .default
9393

9494
/// Default options where input standardization is
95-
/// enabled and the maximum resolution is set to 1080p.
95+
/// requested and the maximum resolution is set to 1080p.
9696
public static let `default`: InputStandardization = InputStandardization(
97-
isEnabled: true,
97+
isRequested: true,
9898
maximumResolution: .default
9999
)
100100

101-
/// Disable all local input standardization by the SDK.
101+
/// Skip all local input standardization by the SDK.
102102
///
103103
/// Initializing an upload with input standardization
104-
/// disabled will prevent the SDK from making any
104+
/// skipped will prevent the SDK from making any
105105
/// changes before commencing the upload. All input
106106
/// will be uploaded to Mux as-is.
107107
///
108108
/// Note: non-standard input will still be converted
109109
/// to a standardized format upon ingestion.
110-
public static let disabled: InputStandardization = InputStandardization(
111-
isEnabled: false,
110+
public static let skipped: InputStandardization = InputStandardization(
111+
isRequested: false,
112112
maximumResolution: .default
113113
)
114114

115115
// Kept private to an invalid combination of parameters
116116
// being used for initialization
117117
private init(
118-
isEnabled: Bool,
118+
isRequested: Bool,
119119
maximumResolution: MaximumResolution
120120
) {
121-
self.isEnabled = isEnabled
121+
self.isRequested = isRequested
122122
self.maximumResolution = maximumResolution
123123
}
124124

@@ -132,7 +132,7 @@ public struct UploadOptions {
132132
public init(
133133
maximumResolution: MaximumResolution
134134
) {
135-
self.isEnabled = true
135+
self.isRequested = true
136136
self.maximumResolution = maximumResolution
137137
}
138138
}
@@ -166,9 +166,9 @@ public struct UploadOptions {
166166
/// - Parameters:
167167
/// - inputStandardization: settings to enable or
168168
/// disable standardizing the format of the direct
169-
/// upload inputs, enabled by default. To prevent the
170-
/// SDK from making any changes to the format of the
171-
/// input use ``UploadSettings.InputStandardization.disabled``
169+
/// upload inputs, it is requested by default. To
170+
/// prevent the SDK from making any changes to the
171+
/// format of the input use ``UploadSettings.InputStandardization.skipped``
172172
/// - transport: settings for transporting the
173173
/// direct upload input to Mux
174174
/// - eventTracking: event tracking settings for the

‎Tests/MuxUploadSDKTests/Upload Tests/ReporterTests.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ class ReporterTests: XCTestCase {
1414

1515
static let inputStandardizationSucceeded = #"{"data":{"app_name":"AcmeApp","app_version":"3.2.1","device_model":"iPad","input_duration":3.1400000000000001,"input_size":1500000,"maximum_resolution":"default","non_standard_input_reasons":[],"platform_name":"iPadOS","platform_version":"15.0.0","sdk_version":"0.4.1","standardization_end_time":"2023-07-07T03:43:58Z","standardization_start_time":"2023-07-07T03:38:58Z","upload_url":"https:\/\/www.example.com"},"session_id":"jkl567","type":"upload_input_standardization_succeeded","version":"1"}"#
1616

17-
static let uploadFailed = #"{"data":{"app_name":"AcmeApp","app_version":"3.2.1","device_model":"iPad","error_description":"foo","input_duration":3.1400000000000001,"input_size":1500000,"input_standardization_enabled":false,"platform_name":"iPadOS","platform_version":"16.2.0","region_code":"US","sdk_version":"0.3.0","upload_end_time":"2023-07-07T04:12:48Z","upload_start_time":"2023-07-07T04:12:18Z","upload_url":"https:\/\/www.example.com"},"session_id":"abc123","type":"upload_failed","version":"1"}"#
17+
static let uploadFailed = #"{"data":{"app_name":"AcmeApp","app_version":"3.2.1","device_model":"iPad","error_description":"foo","input_duration":3.1400000000000001,"input_size":1500000,"input_standardization_requested":false,"platform_name":"iPadOS","platform_version":"16.2.0","region_code":"US","sdk_version":"0.3.0","upload_end_time":"2023-07-07T04:12:48Z","upload_start_time":"2023-07-07T04:12:18Z","upload_url":"https:\/\/www.example.com"},"session_id":"abc123","type":"upload_failed","version":"1"}"#
1818

19-
static let uploadSucceeded = #"{"data":{"app_name":"AcmeApp","app_version":"3.2.1","device_model":"iPad","input_duration":3.1400000000000001,"input_size":1500000,"input_standardization_enabled":true,"platform_name":"iPadOS","platform_version":"16.2.0","region_code":"US","sdk_version":"0.3.0","upload_end_time":"2023-07-07T04:12:48Z","upload_start_time":"2023-07-07T04:12:18Z","upload_url":"https:\/\/www.example.com"},"session_id":"abc123","type":"upload_succeeded","version":"1"}"#
19+
static let uploadSucceeded = #"{"data":{"app_name":"AcmeApp","app_version":"3.2.1","device_model":"iPad","input_duration":3.1400000000000001,"input_size":1500000,"input_standardization_requested":true,"platform_name":"iPadOS","platform_version":"16.2.0","region_code":"US","sdk_version":"0.3.0","upload_end_time":"2023-07-07T04:12:48Z","upload_start_time":"2023-07-07T04:12:18Z","upload_url":"https:\/\/www.example.com"},"session_id":"abc123","type":"upload_succeeded","version":"1"}"#
2020
}
2121

2222
var jsonEncoder = Reporter().jsonEncoder
@@ -101,7 +101,7 @@ class ReporterTests: XCTestCase {
101101
errorDescription: "foo",
102102
inputDuration: 3.14,
103103
inputSize: 1_500_000,
104-
inputStandardizationEnabled: false,
104+
inputStandardizationRequested: false,
105105
platformName: "iPadOS",
106106
platformVersion: "16.2.0",
107107
regionCode: "US",
@@ -136,7 +136,7 @@ class ReporterTests: XCTestCase {
136136
deviceModel: "iPad",
137137
inputDuration: 3.14,
138138
inputSize: 1_500_000,
139-
inputStandardizationEnabled: true,
139+
inputStandardizationRequested: true,
140140
platformName: "iPadOS",
141141
platformVersion: "16.2.0",
142142
regionCode: "US",

‎Tests/MuxUploadSDKTests/UploadManagerTests/UploadManagerTests.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ import XCTest
1010

1111
extension UploadOptions {
1212

13-
static var inputStandardizationDisabled: UploadOptions {
13+
static var inputStandardizationSkipped: UploadOptions {
1414
UploadOptions(
15-
inputStandardization: .disabled
15+
inputStandardization: .skipped
1616
)
1717
}
1818

@@ -37,7 +37,7 @@ class UploadManagerTests: XCTestCase {
3737
asset: AVAsset(url: videoInputURL),
3838
info: UploadInfo(
3939
uploadURL: uploadURL,
40-
options: .inputStandardizationDisabled
40+
options: .inputStandardizationSkipped
4141
)
4242
),
4343
uploadManager: uploadManager
@@ -48,7 +48,7 @@ class UploadManagerTests: XCTestCase {
4848
asset: AVAsset(url: videoInputURL),
4949
info: UploadInfo(
5050
uploadURL: uploadURL,
51-
options: .inputStandardizationDisabled
51+
options: .inputStandardizationSkipped
5252
)
5353
),
5454
uploadManager: uploadManager

0 commit comments

Comments
 (0)