BDKBroadcastScreensharingToolConfiguration

Objective-C


@interface BDKBroadcastScreensharingToolConfiguration : NSObject <NSCopying>

Swift

class BroadcastScreensharingToolConfiguration : NSObject, NSCopying

A value object holding the configuration values for the Bandyer “broadcast screensharing” tool. You can create this object when you want to enable or disable the “broadcast screensharing” tool in Bandyer calls. When enabling the “broadcast screensharing” tool you are required to provide the app group identifier shared by your app and the your broadcast upload extension. The broadcastExtensionBundleIdentifier is the bundle identifier of your broadcast upload extension, that identifier is needed by the BandyerSDK when it is asked to present the RPSystemBroadcastPickerView on devices running iOS 12 and above. When a value is provided, the BandyerSDK will present the user only your app, among those installed on the user device that provides a broadcast upload extension. If you don’t provide one, however, the user will be presented with a list of all apps installed on her / his device providing a broadcast extension.

  • A boolean flag indicating whether the broadcast screensharing tool is enabled or disabled.

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isEnabled) BOOL enabled;

    Swift

    var isEnabled: Bool { get }

  • The app group identifier needed by the SDK in order to share information with the broadcast extension.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSString *appGroupIdentifier;

    Swift

    var appGroupIdentifier: String? { get }

  • The bundle identifier of your broadcast upload extension.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSString *broadcastExtensionBundleIdentifier;

    Swift

    var broadcastExtensionBundleIdentifier: String? { get }

  • Creates a new BDKBroadcastScreensharingToolConfiguration object instance with enabled property to false.

    Declaration

    Objective-C

    + (nonnull instancetype)disabled;

    Swift

    class func disabled() -> Self

    Return Value

    A new BDKBroadcastScreensharingToolConfiguration object instance with enabled property to false.

  • Creates a new BDKBroadcastScreensharingToolConfiguration object instance with enabled property to true.

    Declaration

    Objective-C

    + (nonnull instancetype)enabledWithAppGroupIdentifier:
    (nonnull NSString *)appGroupIdentifier;

    Swift

    class func enabled(appGroupIdentifier: String) -> Self

    Parameters

    appGroupIdentifier

    The application group identifier. Cannot be nil otherwise an exception will be thrown.

    Return Value

    A new BDKBroadcastScreensharingToolConfiguration object instance with enabled property to true.

  • Creates a new BDKBroadcastScreensharingToolConfiguration object instance with enabled property to true.

    Declaration

    Objective-C

    + (nonnull instancetype)enabledWithAppGroupIdentifier:
                            (nonnull NSString *)appGroupIdentifier
                   broadcastExtensionBundleIdentifier:
                       (nullable NSString *)broadcastExtensionBundleIdentifier;

    Swift

    class func enabled(appGroupIdentifier: String, broadcastExtensionBundleIdentifier: String?) -> Self

    Parameters

    appGroupIdentifier

    The application group identifier. Cannot be nil otherwise an exception will be thrown.
    broadcastExtensionBundleIdentifier

    The bundle identifier of your broadcast upload extension. May be nil.

    Return Value

    A new BDKBroadcastScreensharingToolConfiguration object instance with enabled property to true.