aboutsummaryrefslogtreecommitdiffstats
path: root/src/modules/mediaplayer
diff options
context:
space:
mode:
authorGravatar un1versal2015-12-09 11:58:53 +0000
committerGravatar un1versal2015-12-19 02:40:22 +0000
commit7d4516afc4cd194f9224dcd5e07e0f234c162fdf (patch)
treea1a165c897339fcbd35a27108fe16c999a3041e2 /src/modules/mediaplayer
parentMerge pull request #1776 from TheReign/issue_1754_2 (diff)
downloadKVIrc-7d4516afc4cd194f9224dcd5e07e0f234c162fdf.tar.gz
KVIrc-7d4516afc4cd194f9224dcd5e07e0f234c162fdf.tar.bz2
KVIrc-7d4516afc4cd194f9224dcd5e07e0f234c162fdf.zip
src/modules typos: capitalize, formatting, consistency and syntax fixes
Diffstat (limited to 'src/modules/mediaplayer')
-rw-r--r--src/modules/mediaplayer/MpAmipInterface.cpp4
-rw-r--r--src/modules/mediaplayer/MpMprisInterface.cpp22
-rw-r--r--src/modules/mediaplayer/MpSpotifyInterface.cpp2
-rw-r--r--src/modules/mediaplayer/MpWinampInterface.cpp8
-rw-r--r--src/modules/mediaplayer/MpXmmsInterface.cpp4
-rw-r--r--src/modules/mediaplayer/libkvimediaplayer.cpp60
6 files changed, 55 insertions, 45 deletions
diff --git a/src/modules/mediaplayer/MpAmipInterface.cpp b/src/modules/mediaplayer/MpAmipInterface.cpp
index c3bba45cb..4b41ff9c2 100644
--- a/src/modules/mediaplayer/MpAmipInterface.cpp
+++ b/src/modules/mediaplayer/MpAmipInterface.cpp
@@ -110,10 +110,10 @@ MP_IMPLEMENT_DESCRIPTOR(
MpAmipInterface,
"amip",
__tr2qs_ctx(
- "An interface to the AMIP plug-in.\n" \
+ "An interface for the AMIP plugin.\n" \
"You can download it from http://amip.tools-for.net\n" \
"To use this interface you must " \
- "install AMIP plug-in for your player."
+ "install AMIP plugin for your player."
,
"mediaplayer"
)
diff --git a/src/modules/mediaplayer/MpMprisInterface.cpp b/src/modules/mediaplayer/MpMprisInterface.cpp
index 75f14e7d5..0f042c8ee 100644
--- a/src/modules/mediaplayer/MpMprisInterface.cpp
+++ b/src/modules/mediaplayer/MpMprisInterface.cpp
@@ -317,7 +317,7 @@ MP_IMPLEMENT_DESCRIPTOR(
MpAudaciousInterface,
"audacious",
__tr2qs_ctx(
- "An interface to the popular audacious media player.\n" \
+ "An interface for the popular Audacious media player.\n" \
"Download it from http://audacious-media-player.org\n"
,
"mediaplayer"
@@ -443,7 +443,7 @@ MP_IMPLEMENT_DESCRIPTOR(
MpBmpxInterface,
"bmpx",
__tr2qs_ctx(
- "An interface to BMPx.\n" \
+ "An interface for BMPx.\n" \
"Download it from http://sourceforge.net/projects/beepmp\n"
,
"mediaplayer"
@@ -467,7 +467,7 @@ MP_IMPLEMENT_DESCRIPTOR(
MpAmarok2Interface,
"amarok2",
__tr2qs_ctx(
- "An interface to Amarok2.\n" \
+ "An interface for Amarok2.\n" \
"Download it from http://amarok.kde.org\n"
,
"mediaplayer"
@@ -485,7 +485,7 @@ MP_IMPLEMENT_DESCRIPTOR(
MpQmmpInterface,
"Qmmp",
__tr2qs_ctx(
- "An interface to Qmmp.\n" \
+ "An interface for Qmmp.\n" \
"Download it from http://qmmp.ylsoftware.com\n"
,
"mediaplayer"
@@ -503,7 +503,7 @@ MP_IMPLEMENT_DESCRIPTOR(
MpXmms2Interface,
"xmms2",
__tr2qs_ctx(
- "An interface to the Xmms2 media player.\n" \
+ "An interface for the XMMS2 media player.\n" \
"Download it from http://xmms2.org\n",
"mediaplayer"
)
@@ -520,7 +520,7 @@ MP_IMPLEMENT_DESCRIPTOR(
MpSongbirdInterface,
"songbird",
__tr2qs_ctx(
- "An interface to the Mozilla Songbird media player.\n" \
+ "An interface for the Mozilla Songbird media player.\n" \
"Download it from http://www.getsongbird.com.\n" \
"To use it you have to install also the MPRIS addon " \
"available at http://addons.songbirdnest.com/addon/1626.\n",
@@ -544,7 +544,7 @@ MP_IMPLEMENT_DESCRIPTOR(
MpTotemInterface,
"totem",
__tr2qs_ctx(
- "An interface to Totem.\n" \
+ "An interface for Totem.\n" \
"Download it from http://projects.gnome.org/totem/\n"
,
"mediaplayer"
@@ -562,10 +562,10 @@ MP_IMPLEMENT_DESCRIPTOR(
MpVlcInterface,
"vlc",
__tr2qs_ctx(
- "An interface to Vlc.\n" \
+ "An interface for VLC.\n" \
"Download it from http://www.videolan.org/\n" \
- "You need to manually enable the DBus control\n" \
- "interface in the Vlc preferences\n" \
+ "You need to manually enable the D-Bus control\n" \
+ "interface in the VLC preferences\n" \
,
"mediaplayer"
)
@@ -582,7 +582,7 @@ MP_IMPLEMENT_DESCRIPTOR(
MpClementineInterface,
"clementine",
__tr2qs_ctx(
- "An interface to Clementine.\n" \
+ "An interface for Clementine.\n" \
"Download it from http://www.clementine-player.org/\n" \
,
"mediaplayer"
diff --git a/src/modules/mediaplayer/MpSpotifyInterface.cpp b/src/modules/mediaplayer/MpSpotifyInterface.cpp
index ba1e8fa5e..9bc2c8b1c 100644
--- a/src/modules/mediaplayer/MpSpotifyInterface.cpp
+++ b/src/modules/mediaplayer/MpSpotifyInterface.cpp
@@ -47,7 +47,7 @@ MP_IMPLEMENT_DESCRIPTOR(
KviSpotifyInterface,
"spotify",
__tr2qs_ctx(
- "An interface to the Spotify music streaming service.\n" \
+ "An interface for the Spotify music streaming service.\n" \
"It is only available for certain countries in Europe.\n" \
"You can download it from http://www.spotify.com.\n"
,
diff --git a/src/modules/mediaplayer/MpWinampInterface.cpp b/src/modules/mediaplayer/MpWinampInterface.cpp
index e31880746..c842e4ed6 100644
--- a/src/modules/mediaplayer/MpWinampInterface.cpp
+++ b/src/modules/mediaplayer/MpWinampInterface.cpp
@@ -185,7 +185,7 @@ static HWND find_winamp(KviWinampInterface * i)
if(!hWnd)
{
// try to start the process ?
- i->setLastError(__tr2qs_ctx("Can't find a running winamp window","mediaplayer"));
+ i->setLastError(__tr2qs_ctx("Can't find a running Winamp window","mediaplayer"));
}
return hWnd;
}
@@ -195,7 +195,7 @@ MP_IMPLEMENT_DESCRIPTOR(
KviWinampInterface,
"winamp",
__tr2qs_ctx(
- "An interface to the popular Winamp media player.\n" \
+ "An interface for the popular Winamp media player.\n" \
"You can download it from http://www.winamp.com.\n" \
"To use all the features of this interface you must " \
"copy the gen_kvirc.dll plugin found in the KVIrc " \
@@ -317,7 +317,7 @@ QString KviWinampInterface::mrl()
if(ret2 != KVIRC_WM_USER_CHECK_REPLY)
{
- setLastError(__tr2qs_ctx("The winamp plugin has not been installed properly. Check /help mediaplayer.nowplaying","mediaplayer"));
+ setLastError(__tr2qs_ctx("The Winamp plugin has not been installed properly. Check /help mediaplayer.nowplaying","mediaplayer"));
return ret;
}
@@ -351,7 +351,7 @@ QString KviWinampInterface::nowPlaying()
int retpippo = SendMessage(hWinamp,WM_USER,KVIRC_WM_USER,KVIRC_WM_USER_CHECK);
if(retpippo != KVIRC_WM_USER_CHECK_REPLY)
{
- setLastError(__tr2qs_ctx("The winamp plugin has not been installed properly. Check /help mediaplayer.nowplaying","mediaplayer") );
+ setLastError(__tr2qs_ctx("The Winamp plugin has not been installed properly. Check /help mediaplayer.nowplaying","mediaplayer") );
return ret;
}
diff --git a/src/modules/mediaplayer/MpXmmsInterface.cpp b/src/modules/mediaplayer/MpXmmsInterface.cpp
index b5217fad8..20cba7c5c 100644
--- a/src/modules/mediaplayer/MpXmmsInterface.cpp
+++ b/src/modules/mediaplayer/MpXmmsInterface.cpp
@@ -35,7 +35,7 @@ MP_IMPLEMENT_DESCRIPTOR(
KviXmmsInterface,
"xmms",
__tr2qs_ctx(
- "An interface to the popular UNIX xmms media player.\n" \
+ "An interface for the popular UNIX XMMS media player.\n" \
"Download it from http://legacy.xmms2.org\n"
,
"mediaplayer"
@@ -46,7 +46,7 @@ MP_IMPLEMENT_DESCRIPTOR(
KviAudaciousClassicInterface,
"audacious classic",
__tr2qs_ctx(
- "An interface to the popular UNIX audacious media player.\n" \
+ "An interface for the popular UNIX Audacious media player.\n" \
"Download it from http://audacious-media-player.org\n"
,
"mediaplayer"
diff --git a/src/modules/mediaplayer/libkvimediaplayer.cpp b/src/modules/mediaplayer/libkvimediaplayer.cpp
index 2445f2d1a..908f7914d 100644
--- a/src/modules/mediaplayer/libkvimediaplayer.cpp
+++ b/src/modules/mediaplayer/libkvimediaplayer.cpp
@@ -71,7 +71,7 @@ static MpInterface * auto_detect_player(KviWindow * pOut = 0)
if(iBest < 90)
{
if(pOut)
- pOut->outputNoFmt(KVI_OUT_MULTIMEDIA,__tr2qs_ctx("Not sure about the results, trying a second, more agressive detection pass","mediaplayer"));
+ pOut->outputNoFmt(KVI_OUT_MULTIMEDIA,__tr2qs_ctx("Not sure about the results, trying a second, more aggressive detection pass","mediaplayer"));
// no sure player found... try again with a destructive test
for(d = g_pDescriptorList->first();d;d = g_pDescriptorList->next())
{
@@ -230,7 +230,7 @@ MP_KVS_SIMPLE_COMMAND(hide,hide)
@description:
Show the player interface.[br]
When you use this function in your script, remember to reshow mediaplayer's window [br]
- or quit the mediplayerwindow to the exit.[br]
+ or quit the mediaplayer window to the exit.[br]
Take a look at the [module:mediaplayer]mediaplayer module documentation[/module]
for more details about how it works.[br]
@seealso:
@@ -543,9 +543,14 @@ MP_KVS_FUNCTION(playerList)
mediaplayer.playMrl <mrl>
@description:
Plays the media specified by the <mrl> on the currently
- selected media player interface. <mrl> is a standard Media Resource
- Locator. Examples of such locators are: 'file:///home/myfile.mp3',
- 'http://streaming.server.top:123', 'dvd:// or dvb://channelname'.
+ selected media player interface. MRL is a standard Media Resource Locator.
+ Examples of such locators are:
+ [example]
+ file:///home/myfile.mp3
+ http://streaming.server.top:123
+ dvd:///dev/dvd
+ dvb://channelname
+ [/example]
Take a look at the [module:mediaplayer]mediaplayer module documentation[/module]
for more details about how it works.[br]
@seealso:
@@ -736,15 +741,20 @@ MP_KVS_SIMPLE_COMMAND(mute,mute)
@title:
$mediaplayer.mrl
@short:
- Returns the mrl of the currently played media
+ Returns the MRL of the currently playing media
@syntax:
$mediaplayer.mrl()
@description:
- Returns the mrl of the media currently played by the selected media player interface.
- The mrl is a standard Media Resource Locator.
- Examples of such locators are: 'file:///home/myfile.mp3',
- 'http://streaming.server.top:123', 'dvd:// or dvb://channelname'.
- This means that the returned string may NOT refer to a local file:
+ Returns the MRL of the media currently played by the selected media player interface.
+ The MRL is a standard Media Resource Locator.
+ Examples of such locators are:
+ [example]
+ file:///home/myfile.mp3
+ http://streaming.server.top:123
+ dvd:///dev/dvd
+ dvb://channelname
+ [/example]
+ This means that the returned string may [b]not[/b] refer to a local file:
it refers to the local file only if the 'file://' prefix is found ([fnc]$mediaplayer.localFile()[/fnc]
checks that for you).
The returned string is empty if the player isn't currently playing.[br]
@@ -769,7 +779,7 @@ MP_KVS_SIMPLE_STRING_FUNCTION(mrl,mrl)
@syntax:
$mediaplayer.nowPlaying()
@description:
- Returns a description fo the media currently played
+ Returns a description for the media currently played
by the selected media player interface. The description
will usually contain the title of the media and eventually
some additional information like the artist name or album.
@@ -1261,7 +1271,7 @@ MP_KVS_SIMPLE_INT_FUNCTION(getRepeat,getRepeat)
@title:
$mediaplayer.getShuffle
@short:
- Return if "Shuffle" is on.
+ Return if "shuffle" is on.
@syntax:
$mediaplayer.getShuffle()
@description:
@@ -1283,11 +1293,11 @@ MP_KVS_SIMPLE_BOOL_FUNCTION(getShuffle,getShuffle)
@title:
$mediaplayer.getEqData
@short:
- Return the Equalizer Value.
+ Return the equalizer value.
@syntax:
$mediaplayer.getEqData(<item:integer>,<options:string>)
@description:
- Return the value of the Eq <item>.[br]
+ Return the value of the EQ <item>.[br]
if 'q' is given as an option, it runs in quiet mode.[br]
Take a look at the [module:mediaplayer]mediaplayer module documentation[/module]
for more details about how it works.[br]
@@ -1333,11 +1343,11 @@ MP_KVS_FUNCTION(getEqData)
@title:
mediaplayer.setEqData
@short:
- Return the Equalizer Value.
+ Return the equalizer value.
@syntax:
mediaplayer.setEqData [-q] <item:integer> <value:integer>
@description:
- Set the value of the Eq <item> to <value>.[br]
+ Set the value of the EQ <item> to <value>.[br]
Take a look at the [module:mediaplayer]mediaplayer module documentation[/module]
for more details about how it works.[br]
@seealso:
@@ -1491,15 +1501,15 @@ MP_KVS_FUNCTION(status)
the information about the currently played media (in order to implement the nice /playing
scripts). The module has replaced the old mediaplayer module which after
years of development had developed some design flaws and needed a complete rewrite.
- At the moment of writing the supported players are: xmms (unix), audacious (unix), winamp (windows),
- every player supported by the amip project (windows), every player using the mpris interface
- (amarok2, juk under kde). You choose the player interface by either setting
+ At the moment of writing the supported players are: XMMS (UNIX), Audacious (UNIX), Winamp (Windows),
+ every player supported by the AMIP project (Windows), every player using the MPRIS D-Bus interface
+ (Amarok2, JuK under KDE). You choose the player interface by either setting
the option in the settings dialog, by manually setting [cmd]option[/cmd] stringPreferredMediaPlayer
or by running [cmd]mediaplayer.detect[/cmd] that will guess the media player interface for you.[br]
If you're going to use the Winamp media player then you must install the "gen_kvirc.dll" plugin
- (included in the kvirc distribution) as a "general" winamp plugin.
- This is achieved by simpy copying the file gen_kvirc.dll
- to the winamp plugins directory and restarting winamp.[br]
+ (included in the KVIrc distribution) as a "general" Winamp plugin.
+ This is achieved by simply copying the file gen_kvirc.dll
+ to the Winamp plugins directory and restarting Winamp.[br]
[br]
The commands and functions exported by this module serve mainly for two
purposes: control the playback and get information about the currently played media.
@@ -1510,7 +1520,7 @@ MP_KVS_FUNCTION(status)
[fnc]$mediaplayer.nowplaying()[/fnc] and [fnc]$mediaplayer.mrl()[/fnc].
Several other informative function are available as well but they are not
granted to work with all the supported media players or media types (e.g.
- with winamp you can play video files that probably have no album, genre
+ with Winamp you can play video files that probably have no album, genre
or sampleRate information...).[br]
If you intend to write portable code, you should check the return value
of the functions like [fnc]$mediaplayer.artist()[/fnc], [fnc]$mediaplayer.title()[/fnc]
@@ -1531,7 +1541,7 @@ MP_KVS_FUNCTION(status)
@syntax:
mediaplayer.setRepeat [-q] <repeat:bool>
@description:
- Set the Repeat flag to "repeat" (1 for ON, 0 for OFF).[br]
+ Set the repeat flag to "repeat" (1 for ON, 0 for OFF).[br]
Take a look at the [module:mediaplayer]mediaplayer module documentation[/module]
for more details about how it works.[br]
@seealso: