ACLIPVideo Class Reference

Inherits from NSManagedObject
Declared in ACLIPVideo.h

Overview

An ACLIPVideo encapulates all of the data of a video to be played.

  guid

Unique identifier for the video

var guid: String! { get }
@property (nonatomic, readonly) NSString *guid

Discussion

Unique identifier for the video

Declared In

ACLIPVideo.h

  title

The title of the video

var title: String! { get }
@property (nonatomic, readonly) NSString *title

Discussion

The title of the video

Declared In

ACLIPVideo.h

  runTime

The runtime of the video in seconds

var runTime: NSTimeInterval { get }
@property (nonatomic, readonly) NSTimeInterval runTime

Discussion

The runtime of the video in seconds

Declared In

ACLIPVideo.h

  thumbnailSmallURL

URL to thumbnail for the video. Should be used in conjunction with the UIImageView addition setImageWithURL:

var thumbnailSmallURL: NSURL! { get }
@property (nonatomic, readonly) NSURL *thumbnailSmallURL

Discussion

URL to thumbnail for the video. Should be used in conjunction with the UIImageView addition setImageWithURL:

Declared In

ACLIPVideo.h

  thumbnailMediumURL

URL to thumbnail for the video. Should be used in conjunction with the UIImageView addition setImageWithURL:

var thumbnailMediumURL: NSURL! { get }
@property (nonatomic, readonly) NSURL *thumbnailMediumURL

Discussion

URL to thumbnail for the video. Should be used in conjunction with the UIImageView addition setImageWithURL:

Declared In

ACLIPVideo.h

  thumbnailLargeURL

URL to thumbnail for the video. Should be used in conjunction with the UIImageView addition setImageWithURL:

var thumbnailLargeURL: NSURL! { get }
@property (nonatomic, readonly) NSURL *thumbnailLargeURL

Discussion

URL to thumbnail for the video. Should be used in conjunction with the UIImageView addition setImageWithURL:

Declared In

ACLIPVideo.h

  state

The current state of the video.

var state: ACLIPVideoStateType { get }
@property (nonatomic, readonly) ACLIPVideoStateType state

Discussion

The current state of the video.

Declared In

ACLIPVideo.h

  uploadProgress

The upload progress of the video between 0-1. Value is only valid if the state is ACLIPVideoUploadingState.

var uploadProgress: CGFloat { get }
@property (nonatomic, readonly) CGFloat uploadProgress

Discussion

The upload progress of the video between 0-1. Value is only valid if the state is ACLIPVideoUploadingState.

Declared In

ACLIPVideo.h

  orientation

The orientation of the video.

var orientation: UIInterfaceOrientation { get }
@property (nonatomic, readonly) UIInterfaceOrientation orientation

Discussion

The orientation of the video.

Declared In

ACLIPVideo.h

  aspectRatio

The aspect ratio of the video.

var aspectRatio: ACLIPAspectRatio { get }
@property (nonatomic, readonly) ACLIPAspectRatio aspectRatio

Discussion

The aspect ratio of the video.

Declared In

ACLIPVideo.h

  createdDate

The created date of the video.

var createdDate: NSDate! { get }
@property (nonatomic, readonly) NSDate *createdDate

Discussion

The created date of the video.

Declared In

ACLIPVideo.h

  attributes

The attributes of the video

var attributes: [NSObject: AnyObject]! { get }
@property (nonatomic, readonly) NSDictionary *attributes

Discussion

The attributes of the video

Declared In

ACLIPVideo.h

+ maximumAllowedPixels

Returns the maximum number of pixels allowed for the video.

class func maximumAllowedPixels() -> Int
+ (NSInteger)maximumAllowedPixels

Return Value

The maximum number of pixels for the video’s size.

Discussion

Returns the maximum number of pixels allowed for the video.

The video can be in any aspect ratio with the constraint that the width x hight is less than or equal to the maximum allowed.

Declared In

ACLIPVideo.h

+ maximumVideoLength

Returns the maximum length that a video may be.

class func maximumVideoLength() -> Int
+ (NSInteger)maximumVideoLength

Return Value

The maximum length of the video in seconds.

Discussion

Returns the maximum length that a video may be.

The video’s duration must be less than or equal to returned value.

Declared In

ACLIPVideo.h

+ cachedVideoForGUID:

Returns video for the guid.

class func cachedVideoForGUID(_ guid: String!) -> ACLIPVideo
+ (ACLIPVideo *)cachedVideoForGUID:(NSString *)guid

Parameters

guid

The guid for the video to return.

Return Value

The cached video for the guid. Returns nil if the cache does not contain the video.

Discussion

Returns video for the guid.

Retrieves the video for the guid from the video cache.

Declared In

ACLIPVideo.h

– deleteVideoCompletionBlock:errorBlock:

Deletes the video.

func deleteVideoCompletionBlock(_ completedBlock: ACLIPNetworkCompleteBlock!, errorBlock errorBlock: ACLIPNetworkErrorBlock!)
- (void)deleteVideoCompletionBlock:(ACLIPNetworkCompleteBlock)completedBlock errorBlock:(ACLIPNetworkErrorBlock)errorBlock

Parameters

completedBlock

A block that gets called upon successfully deleting the video. completedBlock can be nil.

errorBlock

A block that gets called when any error occurs. The error can be either a Foundation network error or an ACLIPNetworkReturnType error. errorBlock can be nil in no error handling is requiried.

Discussion

Deletes the video.

Videos that are associated with an ALIPMessage can not be deleted. An ACLIPCantDeleteMessageVideoError will be returned.

Declared In

ACLIPVideo.h