package com.vblast.xiialive.service;

public class XiiaLiveApi 
{
	public final static String INTENT_CATEGORY_FULL =
			"com.vblast.xiialive.intent.category.FULL_VERSION";
	
	public final static String INTENT_CATEGORY_LITE =
			"com.vblast.xiialive.intent.category.LITE_VERSION";
	
	public final static String INTENT_CATEGORY_BETA =
			"com.vblast.xiialive.intent.category.BETA_VERSION";
	
	/**
	 * Adds the given song to the tags table.<br>
	 * <br>
	 * Must contain the following extras: <br>
	 * <code>EXTRA_MEDIA_TITLE</code><i>  Not required</i><br>
	 * <code>EXTRA_MEDIA_TRACK_TITLE</code><br>
	 * <code>EXTRA_MEDIA_TRACK_ARTIST</code>
	 * 
	 */
	public final static String INTENT_ACTION_TAG_SONG = 
			"com.vblast.xiialive.intent.action.TAG_SONG";

	/**
	 * [FULL VERSION ONLY]
	 * Service action to start a new request for playback.
	 * 
	 * @Extra 
	 *  EXTRA_MEDIA_REQ_DATA <br>
	 *  EXTRA_MEDIA_REQ_MIME <br>
	 *  EXTRA_NOTIFICATION_VOLUME <i>[Optional]</i><br>
	 */
	public final static String INTENT_ACTION_PLAYBACK_START = 
			"com.vblast.xiialive.intent.action.PLAYBACK_START";
	
	/**
	 * Service action to resume last played.  If already playing the
	 * requested action will be ignored.
	 */
	public final static String INTENT_ACTION_PLAYBACK_RESUME = 
			"com.vblast.xiialive.intent.action.PLAYBACK_RESUME";
	
	/**
	 * Broadcast or Service action to pause media playback.
	 */
	public final static String INTENT_ACTION_PLAYBACK_PAUSE = 
			"com.vblast.xiialive.intent.action.PLAYBACK_PAUSE";
	
	/**
	 * Service action to toggle playback. 
	 */
	public final static String INTENT_ACTION_PLAYBACK_TOGGLE	= 
			"com.vblast.xiialive.intent.action.PLAYBACK_TOGGLE";
	
	/**
	 * Broadcast or Service action to stop media playback.
	 */
	public final static String INTENT_ACTION_PLAYBACK_STOP = 
			"com.vblast.xiialive.intent.action.PLAYBACK_STOP";
		
	/**
	 * Service action to play a given playlist position. If not
	 * specified or invalid value it will not be handled.
	 * 
	 * @Extra
	 * EXTRA_PLAYLIST_POSITION
	 */
	public final static String INTENT_ACTION_PLAYLIST_PLAY = 
			"com.vblast.xiialive.intent.action.PLAYLIST_PLAY";
	
	/**
	 * [FULL VERSION ONLY]
	 * Service action to play the next playlist item.
	 */
	public final static String INTENT_ACTION_PLAYLIST_NEXT	= 
			"com.vblast.xiialive.intent.action.PLAYLIST_NEXT";

	/**
	 * [FULL VERSION ONLY]
	 * Service action to play the previous playlist item.
	 */
	public final static String INTENT_ACTION_PLAYLIST_PREV	= 
			"com.vblast.xiialive.intent.action.PLAYLIST_PREV";
	
	/**
	 * [FULL VERSION ONLY]
	 * Service action to play the next favorite station.
	 */
	public final static String INTENT_ACTION_FAVORITE_NEXT	= 
			"com.vblast.xiialive.intent.action.FAVORITE_NEXT";

	/**
	 * [FULL VERSION ONLY]
	 * Service action to play the previous favorite station.
	 */
	public final static String INTENT_ACTION_FAVORITE_PREV	= 
			"com.vblast.xiialive.intent.action.FAVORITE_PREV";
	
	/**
	 * Broadcast action to mute media volume.
	 * @Extra
	 * EXTRA_MUTE_STATE
	 */
	public final static String INTENT_ACTION_PLAYBACK_MUTE = 
			"com.vblast.xiialive.intent.action.PLAYBACK_MUTE";
	
	
	/******************************************************
	 *  BROADCASTS
	 ******************************************************/
	
	/**
	 * Sticky broadcast sent out every time there is new metadata available.
	 * @Extra 
	 *  <code>EXTRA_TIMESTAMP</code> (ms) <br>
	 * 	<code>EXTRA_SONG_TITLE</code><br>
	 * 	<code>EXTRA_SONG_ARTIST</code><br>
	 * 	<code>EXTRA_SONG_IS_TAG</code>
	 */
	public final static String INTENT_ACTION_METADATA_UPDATE =
			"com.vblast.xiialive.intent.action.METADATA_UPDATE";
	
	/**
	 * Sticky broadcast sent out every time there is new media information available.
	 * @Extra 
	 * 	<code>EXTRA_REQ_DATA</code><br>
	 * 	<code>EXTRA_REQ_MIME</code><br>
	 * 	<code>EXTRA_COMPLETE</code><br>
	 * 	<code>EXTRA_MEDIA_TITLE</code><br>
	 *  <code>EXTRA_PLAYLIST_POSITION</code><br>
	 * 	<code>EXTRA_MEDIA_BITRATE</code><br>
	 * 	<code>EXTRA_MEDIA_CHANNELS</code><br>
	 * 	<code>EXTRA_MEDIA_SAMPLE_RATE</code><br>
	 * 	<code>EXTRA_MEDIA_GENRE</code><br>
	 *  <code>EXTRA_MEDIA_MIME</code><br>
	 *  <code>EXTRA_MEDIA_URL</code>
	 *  <code>EXTRA_MEDIA_WEBPAGE</code>
	 */
	public final static String INTENT_ACTION_MEDIA_DETAILS_UPDATE =
			"com.vblast.xiialive.intent.action.MEDIA_DETAILS_UPDATE";
	
	
	/**
	 * Broadcast sent out every time there is new playback status
	 * change.
	 * @Extra 
	 * 	EXTRA_PLAYBACK_STATE <br>
	 * 	EXTRA_PLAYBACK_EXTRA1 <br>
	 * 	EXTRA_PLAYBACK_EXTRA2
	 */
	public final static String INTENT_ACTION_PLAYBACK_STATE_UPDATE =
			"com.vblast.xiialive.intent.action.PLAYBACK_STATE_UPDATE";
	
	/**
	 * Sticky broadcast sent out every time there is an update
	 * for the sleep timer.
	 * 
	 * @Extra 
	 * 	EXTRA_SLEEPTIMER_SET_TIMER (ms) <br> 
	 * 	EXTRA_SLEEPTIMER_CURRENT_TIMER (ms) <br> 
	 * 	EXTRA_SLEEPTIMER_SET_FADER (ms) <br> 
	 * 	EXTRA_SLEEPTIMER_CURRENT_FADER (ms) <br> 
	 * 	EXTRA_SLEEPTIMER_RUNNING (true/false)
	 */
	public final static String INTENT_ACTION_SLEEPTIMER_UPDATE =
			"com.vblast.xiialive.intent.action.SLEEPTIMER_UPDATE";
	
	/**
	 * Sticky broadcast streaming statistics.
	 * 
	 * @Extra 
	 *  EXTRA_STATS_STREAM_BAUDRATE<br>
	 *  EXTRA_STATS_TOTAL_DOWNLOADED_BYTES<br>
	 *  EXTRA_STATS_LIFETIME_DOWNLOADED_BYTES<br>
	 *  EXTRA_STATS_LIFETIME_PLAYED_TIME
	 */
	public final static String INTENT_ACTION_STREAM_STATS_UPDATE =
			"com.vblast.xiialive.intent.action.STREAM_STATS_UPDATE";
	
	
	/**
	 * Used for requesting a re-broadcast of the playback state.
	 */
	public final static String INTENT_ACTION_PLAYBACK_STATE_REQUEST =
			"com.vblast.xiialive.intent.action.PLAYBACK_STATE_REQUEST";
	
	/******************************************************
	 *  Common service extras.
	 ******************************************************/
	
	public final static String EXTRA_REQ_DATA = 
			"com.vblast.xiialive.intent.extra.REQ_DATA";
	
	public final static String EXTRA_REQ_MIME = 
			"com.vblast.xiialive.intent.extra.REQ_MIME";
	
	/**
	 * Used for requesting playback encoding.
	 */
	public final static String EXTRA_REQ_ENCODING = 
			"com.vblast.xiialive.intent.extra.REQ_ENCODING";
	
	/** 
	 * A status flag to let know that the intent data is
	 * complete and there is no pending data. Generally
	 * used when reporting stream media information.
	 * 
	 * @type boolean true if the given data is complete.
	 */
	public final static String EXTRA_COMPLETE = 
			"com.vblast.xiialive.intent.extra.COMPLETE";
	
	/**
	 * The title of the current media.
	 * @type String 
	 */
	public final static String EXTRA_MEDIA_TITLE = 
			"com.vblast.xiialive.intent.extra.MEDIA_TITLE";

	public final static String EXTRA_MEDIA_URL = 
			"com.vblast.xiialive.intent.extra.MEDIA_URL";
	
	public final static String EXTRA_MEDIA_MIME = 
			"com.vblast.xiialive.intent.extra.MEDIA_MIME";
	
	public final static String EXTRA_MEDIA_BITRATE = 
			"com.vblast.xiialive.intent.extra.MEDIA_BITRATE";
	
	public final static String EXTRA_MEDIA_SAMPLE_RATE = 
			"com.vblast.xiialive.intent.extra.MEDIA_SAMPLE_RATE";
	
	public final static String EXTRA_MEDIA_CHANNELS = 
			"com.vblast.xiialive.intent.extra.MEDIA_CHANNELS";
	
	public final static String EXTRA_MEDIA_GENRE = 
			"com.vblast.xiialive.intent.extra.MEDIA_GENRE";
	
	public final static String EXTRA_MEDIA_WEBPAGE = 
			"com.vblast.xiialive.intent.extra.MEDIA_WEBSITE";
	
	public final static String EXTRA_SONG_TITLE = 
			"com.vblast.xiialive.intent.extra.SONG_TITLE";
	
	public final static String EXTRA_SONG_ARTIST = 
			"com.vblast.xiialive.intent.extra.SONG_ARTIST";
	
	public final static String EXTRA_DESTINATION_ACTION = 
			"com.vblast.xiialive.intent.extra.DESTINATION_ACTION";
	
	/**
	 * Specifies the mute state.
	 * 
	 * @type boolean True if muted.
	 */
	public final static String EXTRA_MUTE_STATE = 
			"com.vblast.xiialive.intent.extra.MUTE_STATE";
	
	/**
	 * @type int tag state -1:error, 0:not tagged, 1:tagged.
	 */
	public final static String EXTRA_TAG_STATE = 
			"com.vblast.xiialive.intent.extra.TAG_STATE";
	
	/**
	 * @type int current playlist position
	 */
	public final static String EXTRA_PLAYLIST_POSITION = 
			"com.vblast.xiialive.intent.extra.PLAYLIST_POSITION";
	
	/**
	 * @type int time (ms)
	 */
	public final static String EXTRA_SLEEPTIMER_SET_TIMER = 
			"com.vblast.xiialive.sleeptimer_set_timer";
	
	/**
	 * @type int time (ms)
	 */
	public final static String EXTRA_SLEEPTIMER_CURRENT_TIMER = 
			"com.vblast.xiialive.sleeptimer_current_timer";
	
	/**
	 * @type int time (ms)
	 */
	public final static String EXTRA_SLEEPTIMER_SET_FADER = 
			"com.vblast.xiialive.sleeptimer_set_fader";
	
	/**
	 * @type int time (ms)
	 */
	public final static String EXTRA_SLEEPTIMER_CURRENT_FADER = 
			"com.vblast.xiialive.sleeptimer_current_fader";
	
	/**
	 * @type boolean
	 */
	public final static String EXTRA_SLEEPTIMER_RUNNING = 
			"com.vblast.xiialive.sleeptimer_running";
	
	public final static String EXTRA_PLAYBACK_STATE = 
			"com.vblast.xiialive.playback_state";
	
	public final static String EXTRA_PLAYBACK_STATE_EXTRA1 = 
			"com.vblast.xiialive.playback_state_extra1";
	
	public final static String EXTRA_PLAYBACK_STATE_EXTRA2 = 
			"com.vblast.xiialive.playback_state_extra2";
	
	/**
	 * The current live stream download baud rate.
	 * @type int (kbps)
	 */
	public final static String EXTRA_STATS_STREAM_BAUDRATE = 
			"com.vblast.xiialive.stats_stream_baudrate";
	
	/**
	 * Current stream total downloaded bytes.
	 * @type long (bytes)
	 */
	public final static String EXTRA_STATS_DOWNLOADED_BYTES = 
			"com.vblast.xiialive.stats_downloaded_bytes";
	
	/**
	 * Current stream playback time.
	 * @type long (ms)
	 */
	public final static String EXTRA_STATS_PLAYBACK_TIME = 
			"com.vblast.xiialive.stats_playback_time";
	
	/**
	 * Lifetime total downloaded bytes.
	 * @type long (bytes)
	 */
	public final static String EXTRA_STATS_LIFETIME_DOWNLOADED_BYTES = 
			"com.vblast.xiialive.stats_lifetime_total_bytes";
	
	/**
	 * Lifetime total played time.
	 * @type long (ms)
	 */
	public final static String EXTRA_STATS_LIFETIME_PLAYBACK_TIME = 
			"com.vblast.xiialive.stats_lifetime_playback_time";
	
	/**
	 * Notification sound FX volume.
	 * @type Float 0.0f OFF higher is ON
	 */
	public final static String EXTRA_NOTIFICATION_VOLUME = 
			"com.vblast.xiialive.notification_volume";
	
}