Releases/v4.0.0 (#246)

* feat: expose error categorization dimensions (#242)

* build: update minimum deployment target to iOS 12

* feat: expose error categorization parameters for error dispatch on bindings

* docs: fixups

* build: update package dependency

* fix: refrain from sending error dimensions on non-error events (#243)

* chore: remove deprecated API (#244)

* chore: remove duplicate example (#245)

MUXSDKStats.json

@@ -20,5 +20,6 @@
     "3.5.1": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.5.1/MUXSDKStats.xcframework.zip",
     "3.6.0": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.6.0/MUXSDKStats.xcframework.zip",
     "3.6.1": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.6.1/MUXSDKStats.xcframework.zip",
-    "3.6.2": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.6.2/MUXSDKStats.xcframework.zip"
+    "3.6.2": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v3.6.2/MUXSDKStats.xcframework.zip",
+    "4.0.0": "https://github.com/muxinc/mux-stats-sdk-avplayer/releases/download/v4.0.0/MUXSDKStats.xcframework.zip"
 }

MUXSDKStats/MUXSDKStats.xcodeproj/project.pbxproj

@@ -773,7 +773,7 @@
 					"@loader_path/Frameworks",
 				);
 				LOCALIZATION_PREFERS_STRING_CATALOGS = YES;
-				MARKETING_VERSION = 3.6.2;
+				MARKETING_VERSION = 4.0.0;
 				MODULEMAP_FILE = "$(SRCROOT)/MUXSDKStatsVision/module.modulemap";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu17 gnu++20";
@@ -821,7 +821,7 @@
 					"@loader_path/Frameworks",
 				);
 				LOCALIZATION_PREFERS_STRING_CATALOGS = YES;
-				MARKETING_VERSION = 3.6.2;
+				MARKETING_VERSION = 4.0.0;
 				MODULEMAP_FILE = "$(SRCROOT)/MUXSDKStatsVision/module.modulemap";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGES = "objective-c objective-c++";
 				MODULE_VERIFIER_SUPPORTED_LANGUAGE_STANDARDS = "gnu17 gnu++20";
@@ -917,15 +917,15 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.6.2;
+				MARKETING_VERSION = 4.0.0;
 				MODULEMAP_FILE = "$(SRCROOT)/MUXSDKStatsTv/module.modulemap";
 				ONLY_ACTIVE_ARCH = NO;
 				PRODUCT_BUNDLE_IDENTIFIER = com.mux.stats.tvos.MUXSDKStatsTv;
 				PRODUCT_NAME = MUXSDKStats;
 				SDKROOT = appletvos;
 				SKIP_INSTALL = YES;
 				TARGETED_DEVICE_FAMILY = 3;
-				TVOS_DEPLOYMENT_TARGET = 11.0;
+				TVOS_DEPLOYMENT_TARGET = 12.0;
 			};
 			name = Debug;
 		};
@@ -951,14 +951,14 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.6.2;
+				MARKETING_VERSION = 4.0.0;
 				MODULEMAP_FILE = "$(SRCROOT)/MUXSDKStatsTv/module.modulemap";
 				PRODUCT_BUNDLE_IDENTIFIER = com.mux.stats.tvos.MUXSDKStatsTv;
 				PRODUCT_NAME = MUXSDKStats;
 				SDKROOT = appletvos;
 				SKIP_INSTALL = YES;
 				TARGETED_DEVICE_FAMILY = 3;
-				TVOS_DEPLOYMENT_TARGET = 11.0;
+				TVOS_DEPLOYMENT_TARGET = 12.0;
 			};
 			name = Release;
 		};
@@ -1128,13 +1128,13 @@
 				INFOPLIST_FILE = MUXSDKStats/Info.plist;
 				INFOPLIST_KEY_NSHumanReadableCopyright = "Copyright © 2024 Mux, Inc. All rights reserved.";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
-				IPHONEOS_DEPLOYMENT_TARGET = 11.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.6.2;
+				MARKETING_VERSION = 4.0.0;
 				ONLY_ACTIVE_ARCH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = com.mux.stats.ios.MUXSDKStats;
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -1162,13 +1162,13 @@
 				INFOPLIST_FILE = MUXSDKStats/Info.plist;
 				INFOPLIST_KEY_NSHumanReadableCopyright = "Copyright © 2024 Mux, Inc. All rights reserved.";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
-				IPHONEOS_DEPLOYMENT_TARGET = 11.0;
+				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
 				LD_RUNPATH_SEARCH_PATHS = (
 					"$(inherited)",
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
-				MARKETING_VERSION = 3.6.2;
+				MARKETING_VERSION = 4.0.0;
 				ONLY_ACTIVE_ARCH = NO;
 				PRODUCT_BUNDLE_IDENTIFIER = com.mux.stats.ios.MUXSDKStats;
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -1284,7 +1284,7 @@
 			repositoryURL = "https://github.com/muxinc/stats-sdk-objc";
 			requirement = {
 				kind = exactVersion;
-				version = 4.7.1;
+				version = 5.0.1;
 			};
 		};
 /* End XCRemoteSwiftPackageReference section */

MUXSDKStats/MUXSDKStats/MUXSDKPlayerBinding.h

@@ -115,12 +115,86 @@ typedef NS_ENUM(NSUInteger, MUXSDKViewOrientation) {
 - (void)setAdPlaying:(BOOL)isAdPlaying;
 - (BOOL)setAutomaticErrorTracking:(BOOL)automaticErrorTracking;
 - (BOOL)setAutomaticVideoChange:(BOOL)automaticVideoChange;
-- (void)dispatchError:(NSString *)code withMessage:(NSString *)message;
-- (void)dispatchError:(NSString *)code withMessage:(NSString *)message withErrorContext:(NSString *)errorContext;
 - (void)didTriggerManualVideoChange;
 
 #pragma clang diagnostic pop
 
+
+/// Records an error related to the player attached to this binding
+/// and dispatches it to Mux
+/// - Parameters:
+///   - code: error code that should be numeric
+///   - message: message describing the error
+- (void)dispatchError:(nonnull NSString *)code
+          withMessage:(nonnull NSString *)message;
+
+/// Records an error related to the player attached to this binding
+/// and dispatches it to Mux
+/// - Parameters:
+///   - code: error code that should be numeric
+///   - message: message describing the error
+///   - errorContext: additional details for the error such
+///   as a stack trace
+- (void)dispatchError:(nonnull NSString *)code
+          withMessage:(nonnull NSString *)message
+     withErrorContext:(nonnull NSString *)errorContext;
+
+/// Records an error related to the player attached to this binding
+/// and dispatches it to Mux
+/// - Parameters:
+///   - code: error code that should be numeric
+///   - message: message describing the error
+///   - severity: severity of a player error recorded by the SDK
+- (void)dispatchError:(nonnull NSString *)code
+          withMessage:(nonnull NSString *)message
+             severity:(MUXSDKErrorSeverity)severity;
+
+/// Records an error related to the player attached to this binding
+/// and dispatches it to Mux
+/// - Parameters:
+///   - code: error code that should be numeric
+///   - message: message describing the error
+///   - severity: severity of a player error recorded by the SDK
+///   - errorContext: additional details for the error such
+///   as a stack trace
+- (void)dispatchError:(nonnull NSString *)code
+          withMessage:(nonnull NSString *)message
+             severity:(MUXSDKErrorSeverity)severity
+         errorContext:(nonnull NSString *)errorContext;
+
+/// Records an error related to the player attached to this binding
+/// and dispatches it to Mux
+/// - Parameters:
+///   - code: error code that should be numeric
+///   - message: message describing the error
+///   - severity: severity of a player error recorded by the SDK
+///   - isBusinessException: If ``YES`` indicates that the error
+///   is classified to be a business exception. If ``NO``
+///   indicates that the error is classified as a technical
+///   failure. Defaults to ``NO`.
+- (void)dispatchError:(nonnull NSString *)code
+          withMessage:(nonnull NSString *)message
+             severity:(MUXSDKErrorSeverity)severity
+  isBusinessException:(BOOL)isBusinessException;
+
+/// Records an error related to the player attached to this binding
+/// and dispatches it to Mux
+/// - Parameters:
+///   - code: error code that should be numeric
+///   - message: message describing the error
+///   - severity: severity of a player error recorded by the SDK
+///   - isBusinessException: If ``YES`` indicates that the error
+///   is classified to be a business exception. If ``NO``
+///   indicates that the error is classified as a technical
+///   failure. Defaults to ``NO`.
+///   - errorContext: additional details for the error such
+///     as a stack trace
+- (void)dispatchError:(nonnull NSString *)code
+          withMessage:(nonnull NSString *)message
+             severity:(MUXSDKErrorSeverity)severity
+  isBusinessException:(BOOL)isBusinessException
+         errorContext:(nonnull NSString *)errorContext;
+
 - (nonnull id)initWithPlayerName:(nonnull NSString *)playerName
                     softwareName:(nullable NSString *)softwareName;