001/*
002 * Copyright (c) 2011-2017 Nexmo Inc
003 *
004 * Permission is hereby granted, free of charge, to any person obtaining a copy
005 * of this software and associated documentation files (the "Software"), to deal
006 * in the Software without restriction, including without limitation the rights
007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008 * copies of the Software, and to permit persons to whom the Software is
009 * furnished to do so, subject to the following conditions:
010 *
011 * The above copyright notice and this permission notice shall be included in
012 * all copies or substantial portions of the Software.
013 *
014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
020 * THE SOFTWARE.
021 */
022package com.nexmo.client.voice;
023
024import com.fasterxml.jackson.annotation.JsonProperty;
025import com.fasterxml.jackson.core.JsonProcessingException;
026import com.fasterxml.jackson.databind.ObjectMapper;
027import com.nexmo.client.NexmoUnexpectedException;
028
029/**
030 * The JSON payload that will be sent in a {@link TalkRequest}.
031 * <p>
032 * {@code text}: A string of up to 1500 characters containing the message to be synthesized
033 * in the Call or Conversation. Each comma in text adds a short pause to the synthesized speech.
034 * {@link VoiceName}: The name of the voice used to deliver {@code text}.
035 * {@code loop}: The number of times the audio file at stream_url is repeated before the stream ends. Set to 0 to loop infinitely.
036 */
037
038public class TalkPayload {
039    private String text;
040    private VoiceName voiceName;
041    private int loop;
042
043    public TalkPayload(String text, VoiceName voiceName, int loop) {
044        this.text = text;
045        this.voiceName = voiceName;
046        this.loop = loop;
047    }
048
049    public int getLoop() {
050        return loop;
051    }
052
053    public String getText() {
054        return text;
055    }
056
057    @JsonProperty("voice_name")
058    public VoiceName getVoiceName() {
059        return voiceName;
060    }
061
062    public String toJson() {
063        try {
064            ObjectMapper mapper = new ObjectMapper();
065            return mapper.writeValueAsString(this);
066        } catch (JsonProcessingException jpe) {
067            throw new NexmoUnexpectedException("Failed to produce json from TalkPayload object.", jpe);
068        }
069    }
070}