APSMediaBuilderPlugin

Objective-C

@protocol APSMediaBuilderPlugin <KRAdapter>

Swift

protocol APSMediaBuilderPlugin

Defines methods that need to be implemented by any object that want to register as an APSMediaBuilder plugin.

Plugin Execution

Plugin Dictionary Configuration

  • The string key that will be used in the root of JSON and dictionary builder configurations to hold all the specific configuration details for the plugin.

    Declaration

    Objective-C

    - (NSString *_Nonnull)dictionaryConfigurationKey;

    Swift

    func dictionaryConfigurationKey() -> String

    Return Value

    String key.

  • This method is called by the APSMediaBuilder object, in the process of its configuration. The method is only called if in the root of the configuring JSON or NSDictionary there is a key equal to the string defined by the plugin using the dictionaryConfigurationKey method.

    Declaration

    Objective-C

    - (void)configureFromDictionary:(NSDictionary *_Nonnull)configuration;

    Swift

    func configure(from configuration: [AnyHashable : Any])

    Parameters

    configuration

    A NSDictionary object containing the specific plugin configuration data.