apple.soundanalysis.protocol

Interface SNResultsObserving

public interface SNResultsObserving

The interface through which clients receive the results of an analysis request

Method Summary

Modifier and Type	Method and Description
default void	requestDidComplete(SNRequest request) Informs the client that the analysis request was completed normally
default void	requestDidFailWithError(SNRequest request, NSError error) Informs the client of an error produced during analysis
void	requestDidProduceResult(SNRequest request, SNResult result) Provides a new analysis result to the client with the specified time range

Method Detail

requestDidFailWithError

default void requestDidFailWithError(SNRequest request,
                                     NSError error)

Informs the client of an error produced during analysis

If an error is produced by a request, that request will not produce any more results, and is in a terminal state. The request:didFailWithError and requestDidComplete methods are mutually exclusive.

requestDidProduceResult

void requestDidProduceResult(SNRequest request,
                             SNResult result)

Provides a new analysis result to the client with the specified time range

This function will be called each time a new analysis result is available. Different types of analysis may produce results at different rates, spanning different time ranges.

requestDidComplete

default void requestDidComplete(SNRequest request)

Informs the client that the analysis request was completed normally

If an analysis request completes normally, that request will not produce any more results, and is in a terminal state. The request:didFailWithError and requestDidComplete methods are mutually exclusive.