removed white spaces

This commit is contained in:
Andreas Preikschat 2014-03-22 20:19:08 +01:00
parent d5b421aa70
commit 47ad40aaac
1 changed files with 32 additions and 32 deletions

View File

@ -823,7 +823,7 @@ class CallbackDecorators(object):
Callback = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p) Callback = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p)
Callback.__doc__ = '''Callback function notification Callback.__doc__ = '''Callback function notification
\param p_event the event triggering the callback \param p_event the event triggering the callback
''' '''
LogCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int, Log_ptr, ctypes.c_char_p, ctypes.c_void_p) LogCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int, Log_ptr, ctypes.c_char_p, ctypes.c_void_p)
LogCb.__doc__ = '''Callback prototype for LibVLC log message handler. LogCb.__doc__ = '''Callback prototype for LibVLC log message handler.
\param data data pointer as given to L{libvlc_log_set}() \param data data pointer as given to L{libvlc_log_set}()
@ -834,7 +834,7 @@ class CallbackDecorators(object):
\note Log message handlers <b>must</b> be thread-safe. \note Log message handlers <b>must</b> be thread-safe.
\warning The message context pointer, the format string parameters and the \warning The message context pointer, the format string parameters and the
variable arguments are only valid until the callback returns. variable arguments are only valid until the callback returns.
''' '''
VideoLockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p)) VideoLockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p))
VideoLockCb.__doc__ = '''Callback prototype to allocate and lock a picture buffer. VideoLockCb.__doc__ = '''Callback prototype to allocate and lock a picture buffer.
Whenever a new video frame needs to be decoded, the lock callback is Whenever a new video frame needs to be decoded, the lock callback is
@ -846,7 +846,7 @@ planes must be aligned on 32-bytes boundaries.
of void pointers, this callback must initialize the array) [OUT] of void pointers, this callback must initialize the array) [OUT]
\return a private pointer for the display and unlock callbacks to identify \return a private pointer for the display and unlock callbacks to identify
the picture buffers the picture buffers
''' '''
VideoUnlockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p)) VideoUnlockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p))
VideoUnlockCb.__doc__ = '''Callback prototype to unlock a picture buffer. VideoUnlockCb.__doc__ = '''Callback prototype to unlock a picture buffer.
When the video frame decoding is complete, the unlock callback is invoked. When the video frame decoding is complete, the unlock callback is invoked.
@ -859,7 +859,7 @@ but before the picture is displayed.
callback [IN] callback [IN]
\param planes pixel planes as defined by the @ref libvlc_video_lock_cb \param planes pixel planes as defined by the @ref libvlc_video_lock_cb
callback (this parameter is only for convenience) [IN] callback (this parameter is only for convenience) [IN]
''' '''
VideoDisplayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p) VideoDisplayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p)
VideoDisplayCb.__doc__ = '''Callback prototype to display a picture. VideoDisplayCb.__doc__ = '''Callback prototype to display a picture.
When the video frame needs to be shown, as determined by the media playback When the video frame needs to be shown, as determined by the media playback
@ -867,7 +867,7 @@ clock, the display callback is invoked.
\param opaque private pointer as passed to L{libvlc_video_set_callbacks}() [IN] \param opaque private pointer as passed to L{libvlc_video_set_callbacks}() [IN]
\param picture private pointer returned from the @ref libvlc_video_lock_cb \param picture private pointer returned from the @ref libvlc_video_lock_cb
callback [IN] callback [IN]
''' '''
VideoFormatCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_uint), ListPOINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) VideoFormatCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_uint), ListPOINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint))
VideoFormatCb.__doc__ = '''Callback prototype to configure picture buffers format. VideoFormatCb.__doc__ = '''Callback prototype to configure picture buffers format.
This callback gets the format of the video as output by the video decoder This callback gets the format of the video as output by the video decoder
@ -891,47 +891,47 @@ the pixel height.
Furthermore, we recommend that pitches and lines be multiple of 32 Furthermore, we recommend that pitches and lines be multiple of 32
to not break assumption that might be made by various optimizations to not break assumption that might be made by various optimizations
in the video decoders, video filters and/or video converters. in the video decoders, video filters and/or video converters.
''' '''
VideoCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) VideoCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p)
VideoCleanupCb.__doc__ = '''Callback prototype to configure picture buffers format. VideoCleanupCb.__doc__ = '''Callback prototype to configure picture buffers format.
\param opaque private pointer as passed to L{libvlc_video_set_callbacks}() \param opaque private pointer as passed to L{libvlc_video_set_callbacks}()
(and possibly modified by @ref libvlc_video_format_cb) [IN] (and possibly modified by @ref libvlc_video_format_cb) [IN]
''' '''
AudioPlayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_uint, ctypes.c_int64) AudioPlayCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_void_p, ctypes.c_uint, ctypes.c_int64)
AudioPlayCb.__doc__ = '''Callback prototype for audio playback. AudioPlayCb.__doc__ = '''Callback prototype for audio playback.
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN] \param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
\param samples pointer to the first audio sample to play back [IN] \param samples pointer to the first audio sample to play back [IN]
\param count number of audio samples to play back \param count number of audio samples to play back
\param pts expected play time stamp (see libvlc_delay()) \param pts expected play time stamp (see libvlc_delay())
''' '''
AudioPauseCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) AudioPauseCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64)
AudioPauseCb.__doc__ = '''Callback prototype for audio pause. AudioPauseCb.__doc__ = '''Callback prototype for audio pause.
\note The pause callback is never called if the audio is already paused. \note The pause callback is never called if the audio is already paused.
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN] \param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
\param pts time stamp of the pause request (should be elapsed already) \param pts time stamp of the pause request (should be elapsed already)
''' '''
AudioResumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) AudioResumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64)
AudioResumeCb.__doc__ = '''Callback prototype for audio resumption (i.e. restart from pause). AudioResumeCb.__doc__ = '''Callback prototype for audio resumption (i.e. restart from pause).
\note The resume callback is never called if the audio is not paused. \note The resume callback is never called if the audio is not paused.
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN] \param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
\param pts time stamp of the resumption request (should be elapsed already) \param pts time stamp of the resumption request (should be elapsed already)
''' '''
AudioFlushCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64) AudioFlushCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int64)
AudioFlushCb.__doc__ = '''Callback prototype for audio buffer flush AudioFlushCb.__doc__ = '''Callback prototype for audio buffer flush
(i.e. discard all pending buffers and stop playback as soon as possible). (i.e. discard all pending buffers and stop playback as soon as possible).
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN] \param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
''' '''
AudioDrainCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) AudioDrainCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p)
AudioDrainCb.__doc__ = '''Callback prototype for audio buffer drain AudioDrainCb.__doc__ = '''Callback prototype for audio buffer drain
(i.e. wait for pending buffers to be played). (i.e. wait for pending buffers to be played).
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN] \param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
''' '''
AudioSetVolumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_float, ctypes.c_bool) AudioSetVolumeCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_float, ctypes.c_bool)
AudioSetVolumeCb.__doc__ = '''Callback prototype for audio volume change. AudioSetVolumeCb.__doc__ = '''Callback prototype for audio volume change.
\param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN] \param data data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
\param volume software volume (1. = nominal, 0. = mute) \param volume software volume (1. = nominal, 0. = mute)
\param mute muted flag \param mute muted flag
''' '''
AudioSetupCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_int), ListPOINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint)) AudioSetupCb = ctypes.CFUNCTYPE(ctypes.POINTER(ctypes.c_int), ListPOINTER(ctypes.c_void_p), ctypes.c_char_p, ctypes.POINTER(ctypes.c_uint), ctypes.POINTER(ctypes.c_uint))
AudioSetupCb.__doc__ = '''Callback prototype to setup the audio playback. AudioSetupCb.__doc__ = '''Callback prototype to setup the audio playback.
This is called when the media player needs to create a new audio output. This is called when the media player needs to create a new audio output.
@ -941,12 +941,12 @@ This is called when the media player needs to create a new audio output.
\param rate sample rate [IN/OUT] \param rate sample rate [IN/OUT]
\param channels channels count [IN/OUT] \param channels channels count [IN/OUT]
\return 0 on success, anything else to skip audio playback \return 0 on success, anything else to skip audio playback
''' '''
AudioCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p) AudioCleanupCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p)
AudioCleanupCb.__doc__ = '''Callback prototype for audio playback cleanup. AudioCleanupCb.__doc__ = '''Callback prototype for audio playback cleanup.
This is called when the media player no longer needs an audio output. This is called when the media player no longer needs an audio output.
\param opaque data pointer as passed to L{libvlc_audio_set_callbacks}() [IN] \param opaque data pointer as passed to L{libvlc_audio_set_callbacks}() [IN]
''' '''
cb = CallbackDecorators cb = CallbackDecorators
# End of generated enum types # # End of generated enum types #
@ -1210,7 +1210,7 @@ class EventManager(_Ctype):
@note: Only a single notification can be registered @note: Only a single notification can be registered
for each event type in an EventManager instance. for each event type in an EventManager instance.
''' '''
_callback_handler = None _callback_handler = None
@ -1287,7 +1287,7 @@ class Instance(_Ctype):
- a string - a string
- a list of strings as first parameters - a list of strings as first parameters
- the parameters given as the constructor parameters (must be strings) - the parameters given as the constructor parameters (must be strings)
''' '''
def __new__(cls, *args): def __new__(cls, *args):
@ -1753,11 +1753,11 @@ class Instance(_Ctype):
class Media(_Ctype): class Media(_Ctype):
'''Create a new Media instance. '''Create a new Media instance.
Usage: Media(MRL, *options) Usage: Media(MRL, *options)
See vlc.Instance.media_new documentation for details. See vlc.Instance.media_new documentation for details.
''' '''
def __new__(cls, *args): def __new__(cls, *args):
@ -2053,11 +2053,11 @@ class MediaLibrary(_Ctype):
class MediaList(_Ctype): class MediaList(_Ctype):
'''Create a new MediaList instance. '''Create a new MediaList instance.
Usage: MediaList(list_of_MRLs) Usage: MediaList(list_of_MRLs)
See vlc.Instance.media_list_new documentation for details. See vlc.Instance.media_list_new documentation for details.
''' '''
def __new__(cls, *args): def __new__(cls, *args):
@ -2073,10 +2073,10 @@ class MediaList(_Ctype):
def get_instance(self): def get_instance(self):
return getattr(self, '_instance', None) return getattr(self, '_instance', None)
def add_media(self, mrl): def add_media(self, mrl):
"""Add media instance to media list. """Add media instance to media list.
The L{lock} should be held upon entering this function. The L{lock} should be held upon entering this function.
@param mrl: a media instance or a MRL. @param mrl: a media instance or a MRL.
@return: 0 on success, -1 if the media list is read-only. @return: 0 on success, -1 if the media list is read-only.
@ -2193,7 +2193,7 @@ class MediaListPlayer(_Ctype):
It may take as parameter either: It may take as parameter either:
- a vlc.Instance - a vlc.Instance
- nothing - nothing
''' '''
def __new__(cls, arg=None): def __new__(cls, arg=None):
@ -2319,13 +2319,13 @@ class MediaPlayer(_Ctype):
It may take as parameter either: It may take as parameter either:
- a string (media URI), options... In this case, a vlc.Instance will be created. - a string (media URI), options... In this case, a vlc.Instance will be created.
- a vlc.Instance, a string (media URI), options... - a vlc.Instance, a string (media URI), options...
''' '''
def __new__(cls, *args): def __new__(cls, *args):
if len(args) == 1 and isinstance(args[0], _Ints): if len(args) == 1 and isinstance(args[0], _Ints):
return _Constructor(cls, args[0]) return _Constructor(cls, args[0])
if args and isinstance(args[0], Instance): if args and isinstance(args[0], Instance):
instance = args[0] instance = args[0]
args = args[1:] args = args[1:]
@ -2397,13 +2397,13 @@ class MediaPlayer(_Ctype):
Specify where the media player should render its video Specify where the media player should render its video
output. If LibVLC was built without Win32/Win64 API output output. If LibVLC was built without Win32/Win64 API output
support, then this has no effects. support, then this has no effects.
@param drawable: windows handle of the drawable. @param drawable: windows handle of the drawable.
""" """
if not isinstance(drawable, ctypes.c_void_p): if not isinstance(drawable, ctypes.c_void_p):
drawable = ctypes.c_void_p(int(drawable)) drawable = ctypes.c_void_p(int(drawable))
libvlc_media_player_set_hwnd(self, drawable) libvlc_media_player_set_hwnd(self, drawable)
def video_get_width(self, num=0): def video_get_width(self, num=0):
"""Get the width of a video in pixels. """Get the width of a video in pixels.
@ -2556,12 +2556,12 @@ class MediaPlayer(_Ctype):
If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
the following code should work: the following code should work:
@begincode @begincode
NSView *video = [[NSView alloc] init]; NSView *video = [[NSView alloc] init];
QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent); QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
L{set_nsobject}(mp, video); L{set_nsobject}(mp, video);
[video release]; [video release];
@endcode @endcode
You can find a live example in VLCVideoView in VLCKit.framework. You can find a live example in VLCVideoView in VLCKit.framework.
@param drawable: the drawable that is either an NSView or an object following the VLCOpenGLVideoViewEmbedding protocol. @param drawable: the drawable that is either an NSView or an object following the VLCOpenGLVideoViewEmbedding protocol.
@ -4430,12 +4430,12 @@ def libvlc_media_player_set_nsobject(p_mi, drawable):
If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then If you want to use it along with Qt4 see the QMacCocoaViewContainer. Then
the following code should work: the following code should work:
@begincode @begincode
NSView *video = [[NSView alloc] init]; NSView *video = [[NSView alloc] init];
QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent); QMacCocoaViewContainer *container = new QMacCocoaViewContainer(video, parent);
L{libvlc_media_player_set_nsobject}(mp, video); L{libvlc_media_player_set_nsobject}(mp, video);
[video release]; [video release];
@endcode @endcode
You can find a live example in VLCVideoView in VLCKit.framework. You can find a live example in VLCVideoView in VLCKit.framework.
@param p_mi: the Media Player. @param p_mi: the Media Player.