VPKImage

@interface VPKImage : UIImage

Drop-in replacement (subclass) for UIImage For use in conjunction with VPKPreview

If VPKImage is initialised with null veepId or imageURL it will behave as a standard UIImage

See

VPKPreview
  • veepId

    The veepId, if available.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSString *veepId;
  • originalContentURI

    The original content URI, if available.

    In the case of an image veep, this will match the source URL of the supplied image.

    For a video veep, this is the source URI for the video media (not the poster image). This may not be an actual URL, but should be the unique identifier used when creating the veep (for example, it could be a youtube id with an appropriate scheme).

    The URI is used to match the content to it’s veep metadata. If a veepId is provided, the URI is ignored as the veep will be fetched by the veepId.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSURL *originalContentURI;
  • alternativeURIs

    An array of alternative identifiers, if available

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSArray *alternativeURIs;
  • veep

    The veep metadata associated with the image, if available

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) VPKVeep *veep;
  • publicVeep

    An abbreviated, header-only version of a veep, if available.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) VPKPublicVeep *publicVeep;
  • mediaIdentifier

    Optional string that the host app can use for tracking purposes.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *mediaIdentifier;
  • customData

    Optional dictionary whose keys and values must be strings. The host app can use for tracking purposes.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDictionary<NSString *, NSString *> *customData;
  • -initWithImage:veepId:

    Use initWithImage:veepId if you are identifying veep content using the unique identifier (id) of the veep.

    See

    -initWithImage:url:

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImage:(nonnull UIImage *)image
                               veepId:(nullable NSString *)veepId;
    Parameters
    image

    The UIImage that this instance will subclass
    veepId

    A veep identifier. Veep metadata will be associated with the image using this identifier. The veep Id is returned as part of the veep creation process.
    Return Value

    An instance of VPKImage.

  • -initWithImage:url:

    Use initWithImage:url if you are identifying veep content using the original URI used to create the veep.

    See

    -initWithImage:veepId:

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImage:(nonnull UIImage *)image
                                  url:(nonnull NSURL *)contentURI;
    Parameters
    image

    The UIImage that this instance will subclass
    contentURI

    The contentURI is the unique identifier for the veep’d resource. In the case of an image this will often be the source URL used to obtain the UIImage. In the case of video this will be the source address of the video asset. The contentURI must be the same URI as was used to create the veep as that is how veeps are identified.
    Return Value

    An instance of VPKImage.

  • -updateWithVeep:

    sets the veep, veepId and originalContentUri

    Declaration

    Objective-C

    - (void)updateWithVeep:(nonnull VPKVeep *)veep;
  • -updateWithPublicVeep:

    sets the publicVeep (a veep header stub), veepId and originalContentUri.

    Declaration

    Objective-C

    - (void)updateWithPublicVeep:(nonnull VPKPublicVeep *)veep;