SSPDSyncTiming

Superclass:	NSObject
Declared In:	SSPDSyncTiming.h

Introduction

timings of beats in bars for synchronisation support for SSPlayData

Methods

+createFromJSON: create from a JSON-encoded file
+createFromJSON:error:: create from a JSON-encoded file
-getRawTimingInfo:: fill the C timing struct
-initWithBarsArray: initialise with array of SSBarTiming
-initWithBarsArray:mediaStart:: initialise with array of SSBarTiming
-saveToJSONUrl:: save to a JSON file

createFromJSON

create from a JSON-encoded file

+(nullable SSPDSyncTiming*)createFromJSON:(nonnull NSURL *)url 
        error:(NSError**)error;

Parameters

url: the URL of a JSON file saved from saveToJSONUrl
error: the error if the returned value is nil

See Also

createFromJSON:error:

createFromJSON:error:

create from a JSON-encoded file

+(nullable SSPDSyncTiming*)createFromJSON:(nonnull NSURL *)url 
        error:(NSError**)error;

Parameters

url: the URL of a JSON file saved from saveToJSONUrl
error: the error if the returned value is nil

See Also

createFromJSON

getRawTimingInfo:

fill the C timing struct

-(bool)getRawTimingInfo:(nonnull sscore_pd_timinginfo*)rval;

Parameters

rval: pointer to a C struct sscore_pd_timinginfo

Return Value

false if failed (rval = nil)

initWithBarsArray

initialise with array of SSBarTiming

-(nonnull instancetype)initWithBarsArray:(nonnull NSArray<SSPDBarTiming*> *)bars 
        mediaStart:(int)mediaStart_ms;

Parameters

bars: the array of bars
mediaStart_ms: the delay for media start from start of play of first bar

Return Value

an object of type SSPDSyncTiming

See Also

initWithBarsArray:mediaStart:

initWithBarsArray:mediaStart:

initialise with array of SSBarTiming

-(nonnull instancetype)initWithBarsArray:(nonnull NSArray<SSPDBarTiming*> *)bars 
        mediaStart:(int)mediaStart_ms;

Parameters

bars: the array of bars
mediaStart_ms: the delay for media start from start of play of first bar

See Also

initWithBarsArray

saveToJSONUrl:

save to a JSON file

-(bool)saveToJSONUrl:(nonnull NSURL*)url;

Parameters

url: the URL of file to save this encoded as JSON

Properties

barFaults: check valid timings
bars: the array of bar timings
json: for JSON serialisation
mediaStart_ms: the time at which to start any synchronised media (default = 0)

barFaults

check valid timings

@property (readonly,
    nonnull) NSArray<NSNumber*> *barFaults;

Return Value

array of bar numbers with inconsistent timings

bars

the array of bar timings

@property (readonly,
    nonnull) NSArray<SSPDBarTiming*> *bars;

json

for JSON serialisation

@property (readonly,
    nonnull) NSDictionary *json;

mediaStart_ms

the time at which to start any synchronised media (default = 0)

@property (readonly) int mediaStart_ms;

Last Updated: Sunday, July 03, 2016