/*

* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Note IDs and other definitions for secondary displays

*

*/

#ifndef MPLAYERSECONDARYDISPLAYAPI_H

#define MPLAYERSECONDARYDISPLAYAPI_H

/**

* Category value used for Music Player notes

*/

const TUid KMPlayerNoteCategory = {0x102072C3};

/**

* Note IDs for notes Music Player publishes for secondary display

* implementations.

*

* \%U parameters are passed as 16-bit descriptors and \%N parameters as 32-bit

* signed integers in the data buffer given to mediator command observers.

*

* @note The \% character is escaped in comments to make sure documentation

* parsers parse this file correctly.

*

* @see CMediatorCommandResponder

* @since S60 3.2.3

*/

enum TMPlayerSecondaryDisplayNote

    {

    /**

     * Not used.

     */

    EMPlayerNoteNone = 0,

    /**

     * Confirmation note after saving a clip or a playlist.

     * - \%U is the title of the saved track or playlist

     *

     * \em qtn_mus_note_saved_to_collection

     * "%U saved to Music Library"

     */

    EMPlayerNoteClipSaved,

    /**

     * Error note when attempting to play an invalid or corrupted clip.

     *

     * \em qtn_mp_note_corrupt_file

     * "File is corrupt. Operation cancelled."

     */

    EMPlayerNoteInvalidClip,

    /**

     * Error note when attempting to play an invalid or corrupted playlist.

     *

     * \em qtn_nmp_note_open_broken_playlist

     * "Playlist file cannot be found. Unable to open."

     */

    EMPlayerNoteInvalidPlaylist,

    /**

     * Error note when attempting to play an empty playlist.

     *

     * \em qtn_nmp_note_empty_playlist

     * "Playlist is empty.\nNothing to play."

     */

    EMPlayerNoteEmptyPlaylist,

    /**

     * Error note when attempting to play a category of tracks and none of the

     * tracks are playable.

     *

     * \em qtn_nmp_note_invalid_list

     * "Unable to play selection. Operation cancelled."

     */

    EMPlayerNoteInvalidGroup,

    /**

     * Wait note shown when Music Library DB is created after starting

     * Music Player for the first time.

     *

     * \em qtn_mus_note_searching

     * "Searching for music."

     */

    EMPlayerNoteCreatingDb,

    /**

     * Information note shown after Music Library DB was was created but

     * no tracks were found.

     *

     * \em qtn_mus_note_search_complete_no_tracks1

     * "Search complete\nNothing found"

     */

    EMPlayerNoteDbCreationCompleteEmpty,

    /**

     * Information note shown after Music Library DB was created and

     * some tracks were found.

     * - \%N is the number of (new) tracks

     *

     * \em qtn_mus_note_search_complete1

     * "Search complete\nSongs: %0N\nPlaylists: %1N"

     */

    EMPlayerNoteDbCreationComplete,

    /**

     * Wait note shown when updating Music Library DB

     * - \%0N is the number of added tracks

     * - \%1N is the number of removed tracks

     *

     * \em qtn_mus_note_updating_db1

     * "Refreshing\nAdded: %0N"

     */

    EMPlayerNoteUpdatingDb,

    /**

     * Information note shown when updating Music Library DB is complete.

     * - \%0N is the number of added tracks

     * - \%1N is the number of removed tracks

     *

     * \em qtn_mus_note_updating_db_complete1

     * "Refresh complete\nAdded: %0N"

     */

    EMPlayerNoteDbUpdateComplete,

    /**

     * Information note shown when updating Music Library DB was stopped

     * by the user.

     * - \%0N is the number of added tracks

     * - \%1N is the number of removed tracks

     *

     * \em qtn_mus_note_updating_db_stopped1

     * "Refresh stopped\nAdded: %0N"

     */

    EMPlayerNoteDbUpdateStopped,

    /**

     * Wait note for updating Music Library DB.

     * No track counts are shown.

     *

     * \em qtn_mus_note_updating_db_short

     * "Updating Music Library."

     */

    EMPlayerNoteUpdatingDbShort,

    /**

     * Information note shown when updating Music Library DB is complete.

     * No track counts are shown.

     *

     * \em qtn_mus_note_update_complete_unmod

     * "Update complete."

     */

    EMPlayerNoteDbUpdateCompleteShort,

    /**

     * Information note shown when updating Music Library DB was stopped

     * by the user. No track counts are shown.

     *

     * \em qtn_mus_note_updating_db_stopped_short

     * "Update stopped."

     */

    EMPlayerNoteDbUpdateStoppedShort,

    /**

     * Error note shown when there is not enough free space on memory card

     * to add all tracks to Music Library DB.

     *

     * \em qtn_mus_note_memory_card_full

     * "Not enough memory to add tracks from memory card to Music Library..."

     */

    EMPlayerNoteDbUpdateDiscFull,

    /**

     * Information note shown when playback had to be paused in progressive

     * download, because all downloaded data has been played.

     *

     * \em qtn_mus_note_played_all_dl_content

     * "All downloaded content has been played."

     */

    EMPlayerNoteAllDlContentPlayed,

    /**

     * Information note shown when attempting to use Music Player during

     * a video call.

     *

     * \em qtn_mus_info_video_call_ongoing

     * "Music Player cannot be used during video call."

     */

    EMPlayerNoteVideoCall,

    /**

     * Note shown when attempting to play a non-protected track when

     * KRequireDRMInPlayback is enabled.

     *

     * \em qtn_mp_info_tone_no_drm

     * "Unprotected file. Cannot be played."

     */

    EMPlayerNoteCannotPlayUnprotected,

    /**

     * Wait note shown when saving a track in embedded mode.

     *

     * \em qtn_gen_note_saving

     * "Saving"

     */

    EMPlayerNoteSaving,

    /**

     * Query shown when attempting to exit Music Player without saving

     * a downloaded/received track/playlist in embedded mode.

     * - \%U is the title of the track or the name of the playlist

     *

     * \em qtn_iv_query_conf_save_downloaded

     * "%U has not been saved. Save now?"

     */

    EMPlayerQueryNotSaved,

    /**

     * Wait note when deleting either a single track or a category.

     * - \%U is the title of the track or the name of the category

     *

     * \em qtn_album_waiting_deleting1 , qtn_mus_query_conf_delete_all1

     * "Deleting '%U'"

     * "Deleting songs belonging to '%U'"

     */

    EMPlayerNoteDeletingSingle,

    /**

     * when deleting several marked tracks.

     *

     * \em qtn_nmp_del_songs_wait_note

     * "Deleting songs"

     */

    EMPlayerNoteDeletingMany,

    /**

     * Confirmation query shown when attempting to delete a category.

     *

     * \em qtn_nmp_query_conf_delete_group

     * "Delete all songs belonging to '%U'?"

     */

    EMPlayerQueryDeleteCategory,

    /**

     * Confirmation query shown when attempting to delete a single track or

     * a playlist.

     *

     * \em qtn_query_common_conf_delete

     * "Delete?\n%U"

     */

    EMPlayerQueryDeleteTrack,

    /**

     * Confirmation query shown when attempting to delete several marked

     * tracks.

     * - \%N is the number of tracks to be deleted

     *

     * \em qtn_nmp_del_songs_query

     * "Delete %N songs?"

     */

    EMPlayerQueryDeleteTracks,

    /**

     * Confirmation query shown when attempting to all tracks in a category

     * to Now Playing List.

     * - \%U is the name of the category

     *

     * \em qtn_mus_query_conf_add_all_to_playing_pl

     * "Add all tracks belonging to %U to Now Playing?"

     */

    EMPlayerQueryAddAllToNowPlaying,

    /**

     * Confirmation query shown when attempting to all tracks in a category

     * to a new playlist.

     * - \%U is the name of the category

     *

     * \em qtn_mus_query_conf_add_all_to_new_pl

     * "Create new playlist of all tracks belonging to %U?"

     */

    EMPlayerQueryAddAllToNewPl,

    /**

     * Confirmation query shown when attempting to all tracks in a category

     * to an existing playlist.

     * - \%U is the name of the category

     *

     * \em qtn_mus_query_conf_add_all_to_pl

     * "Add all tracks belonging to %U to a playlist?"

     */

    EMPlayerQueryAddAllToSavedPl,

    /**

     * Confirmation query shown when attempting to remove several tracks

     * from a playlist.

     * - \%N is the number of tracks to be removed

     *

     * \em qtn_mus_query_conf_remove_many1

     * "Remove %N songs from the playlist?"

     */

    EMPlayerQueryRemoveTracks,

    /**

     * Confirmation query shown when attempting to remove a single track

     * from a playlist.

     * - \%U is the name of the track to be removed

     *

     * \em qtn_mus_query_conf_remove_track

     * "Remove %U from the playlist?"

     */

    EMPlayerQueryRemoveTrack,

    /**

     * Confirmation query shown in embedded mode when setting a track

     * as ringing tone and it has not yet been saved.

     *

     * \em qtn_mp_query_embd_rtone_change_for_all

     * "Tone will be saved to Gallery and changed for all profiles. Continue?"

     */

    EMPlayerQuerySaveAndSetAsRt,

    /**

     * Confirmation query shown when setting a track as ringing tone.

     *

     * \em qtn_mg_query_rtone_change_for_all

     * "Ringing tone will be changed for all profiles. Change?"

     */

    EMPlayerQuerySetAsRt,

    /**

     * Wait note shown when copying tracks/playlists using the organize

     * function.

     *

     * \em qtn_mg_copying_many_files

     * "Copying files"

     */

    EMPlayerNoteCopyingTracks,

    /**

     * Wait note shown when copying a single track or playlist using the

     * organize function.

     * - \%U is the title of the track or name of the playlist

     *

     * \em qtn_mg_waiting_copy

     * "Copying %U"

     */

    EMPlayerNoteCopyingTrack,

    /**

     * Wait note shown when moving tracks/playlists using the organize

     * function.

     *

     * \em qtn_mg_moving_many_files

     * "Moving files"

     */

    EMPlayerNoteMovingTracks,

    /**

     * Wait note shown when moving a single track or playlist using the

     * organize function.

     * - \%U is the title of the track or name of the playlist

     *

     * \em qtn_album_waiting_move

     * "Moving %U"

     */

    EMPlayerNoteMovingTrack,

    /**

     * List query shown when choosing a playlist to add tracks to.

     * List contents are not available for secondary displays.

     *

     * \em qtn_mus_title_select_pl

     * "Select playlist:"

     */

    EMPlayerQuerySelectPlaylist,

    /**

     * List query shown when choosing visualization plug-in.

     *

     * \em qtn_mus_title_select_visualization

     * "Select visualization:"

     */

    EMPlayerQuerySelectVisualization,

    /**

     * Global note shown when running out of disk space when saving, moving,

     * or copying files.

     * - Data buffer contains the drive letter of drive in question

     *

     * \em qtn_memlo_mmc_not_enough_memory or \em qtn_memlo_not_enough_memory

     */

    EMPlayerNoteDiskFull,

    /**

    * Wait Note when MMC card becomes anavailable.

    * \em qtn_nmp_note_mmc_unavailable

    * "Memory card no longer available. Updating music library."

    */

    EMPlayerNoteMMCUnavailableWaitNote,

    /**

    * Wait note when opening album art.

    * \em qtn_nmp_note_opening

    * "Opening..."

    */

    EMPlayerNoteOpeningAlbumArt,

    /**

    * Wait note for opening cache.

    * \em qtn_nmp_note_opening_db

    * "Opening..."

    */

    EMPlayerNoteOpeningDb,

    /**

    * Wait note for scan cancelled opening cache.

    * \em qtn_nmp_note_cancelled_db

    * "Stopping search..."

    */

    EMPlayerNoteCancelledDbWaitNote,

    /**

    * Wait note for completing scan opening cache.

    * \em qtn_nmp_note_completing_db

    * "Completing search..."

    */

    EMPlayerNoteCompletingDb,

    /**

    * Wait note text when renaming a category with one item.

    * \em qtn_nmp_note_updating_name1

    * "Updating 1 song"

    */

    EMPlayerNoteUpdateOneItem,

    /**

    * Wait note text when renaming a category.

    * \em qtn_nmp_note_updating_name

    * "Updating %N songs"

    */

    EMPlayerNoteUpdateManyItems,

    /**

    * Wait note text when a corrupt db has been detected and collection

    *is attempting to rebuild the db

    * \em qtn_nmp_note_rebuilding_db

    * "Repairing corrupt library. Searching for songs."

    */

    EMPlayerNoteRebuildingDb,

     /**

    * Wait note used in wait note while saving an item.

    * \em qtn_nmp_wait_save_one_item

    * "Saving %U"

    */

    EMPlayerNoteSaveOneItem,

    /**

    * Wait Note used when remove one track.

    * \em qtn_mus_note_removing_track1

    * "Removing '%U'"

    */

    EMPlayerNoteRemovingTrack,

    /**

    * Wait note used when remove multiple tracks.

    * \em qtn_nmp_note_removing_many

    * "Removing songs"

    */

    EMPlayerNoteRemovingMany,

    /**

    * Wait note for adding album art.

    * \em qtn_nmp_note_adding_album_art

    * "Changing album art"

    */

    EMPlayerNoteAddingAlbumArt,

    /**

    * Wait note for adding one song.

    * \em qtn_nmp_note_adding_one_song

    * "Adding song"

    */

    EMPlayerNoteAddingSong,

    /**

    * Wait note for adding many songs.

    * \em qtn_mus_note_adding_tracks1

    * "Adding songs"

    */

    EMPlayerNoteAddingManySongs,

    /**

    * Wait note for restoring arlbum art.

    * \em qtn_nmp_note_restoring_album_art

    * "Restoring album art"

    */

    EMPlayerNoteRestoreAlbumArt,

    /**

    * Confirmation query when MMC card is inserted into the phone.

    * \em qtn_nmp_note_mmc_inserted

    * "New memory card detected. Update music library?"

    */

    EMPlayerNoteMMCInserted,

    /**

    * Confirmation query after a MTP sync has occured.

    * \em qtn_nmp_note_library_refresh_sync

    * "Music may need to be refreshed due to recent USB sync. Refresh now?"

    */

    EMPlayerNoteUSBSyncRefresh,

    /**

    * Confirmation query when sending invalid songs.

    * \em qtn_nmp_query_send_valid_songs1

    * "Some songs cannot be sent. Continue?"

    */

    EMPlayerNoteSendInvalidSongs,