Latest 1.1.1
Homepage https://github.com/quentinhayot/QHSpeechSynthesizerQueue
License MIT
Platforms ios 7.0, requires ARC
Authors

Build Status
Queue management system for AVSpeechSynthesizer

Installation

Cocoapods

Add this to your Podfile:

pod 'QHSpeechSynthesizerQueue'

Run a pod install and import the header where you need it:

#import <QHSpeechSynthesizerQueue.h>

Manually

Drop QHSpeechSynthesizerQueue.h and QHSpeechSynthesizerQueue.m in your project, then

#import "QHSpeechSynthesizerQueue.h"

Usage

Initialization

QHSpeechSynthesizerQueue *syntesizerQueue = [[QHSpeechSynthesizerQueue alloc] init];

Adding messages to the queue

Add a message at the end of the queue
[syntesizerQueue readLast:@"This message will be added to the end of the queue" withLanguage:@"en_US" andRate:@"0.2"];
Insert a message to be read immediatly after the current message being read
[syntesizerQueue readNext:@"This message will be read next" withLanguage:@"en_US" andRate:@"0.2" andClearQueue:NO];

If you set andClearQueue: to YES, the queue will be cleared and this will be the last message to be read.

Interrupt the current message and read this one immediately
[syntesizerQueue readImmediately:@"This message will be read next" withLanguage:@"en_US" andRate:@"0.2" andClearQueue:NO];

If you set andClearQueue: to YES, the queue will be cleared and this will be the last message to be read.

Playback actions

Stop

Stop the queue’s playback and clear the queue immediately.

[syntesizerQueue stop];
Stop after current

Stop the queue’s playback and clear the queue. If something is currently being read, it will stop afterwards.

[syntesizerQueue stopAfterCurrent];
Pause

Pause the queue’s playback immediately.

[syntesizerQueue pause];
Pause after current

Pause the queue’s playback. If something is currently being read, it will pause afterwards.

[syntesizerQueue pauseAfterCurrent];
Resume

Resume the queue’s playback.

[syntesizerQueue resume];
Clear queue

Clear the queue. If something is being read, it will not be interupted and future added messages will be read if not paused/stopped.

[syntesizerQueue clearQueue];

Properties

BOOL duckOthers

Set this to YES to duck all the device’s audio sessions when a string is being read. Defaults to YES.

syntesizerQueue.duckOthers = YES;
NSTimeInterval preDelay

The delay before reading a message. Default is 0.0

syntesizerQueue.preDelay = 1.0;
NSTimeInterval postDelay

The delay after reading a message. Default is 0.0

syntesizerQueue.postDelay = 1.0;

Delegate

You can set a QHSpeechSynthesizerQueueDelegate to be notified of playback events.

@protocol QHSpeechSynthesizerQueueDelegate <NSObject>

@optional
- (void)speechSynthesizerQueueDidStartTalking:(QHSpeechSynthesizerQueue *)queue;
- (void)speechSynthesizerQueueDidFinishTalking:(QHSpeechSynthesizerQueue *)queue;
- (void)speechSynthesizerQueueDidPauseTalking:(QHSpeechSynthesizerQueue *)queue;
- (void)speechSynthesizerQueueDidContinueTalking:(QHSpeechSynthesizerQueue *)queue;
- (void)speechSynthesizerQueueDidCancelTalking:(QHSpeechSynthesizerQueue *)queue;
- (void)speechSynthesizerQueueWillStartTalking:(QHSpeechSynthesizerQueue *)queue;

@end

Latest podspec

{
    "name": "QHSpeechSynthesizerQueue",
    "version": "1.1.1",
    "summary": "Queue management system for AVSpeechSynthesizer",
    "homepage": "https://github.com/quentinhayot/QHSpeechSynthesizerQueue",
    "license": {
        "type": "MIT",
        "file": "LICENSE"
    },
    "authors": {
        "Quentin Hayot": "[email protected]"
    },
    "source": {
        "git": "https://github.com/quentinhayot/QHSpeechSynthesizerQueue.git",
        "tag": "1.1.1"
    },
    "platforms": {
        "ios": "7.0"
    },
    "source_files": [
        "QHSpeechSynthesizerQueue/QHSpeechSynthesizerQueue.h",
        "QHSpeechSynthesizerQueue/QHSpeechSynthesizerQueue.m"
    ],
    "requires_arc": true
}

Pin It on Pinterest

Share This