Fix observe_property() docstring
1. Fix decorator name - the decorator for property observation handlers is `@property_observer()`. 2. Fix handler's unregistration method name 3. Fix handler function signature - the signature is ``fun(property_name, new_value)`` and we can't have a bare `*` with no names after it. 4. Fix undefined variable in the example
This commit is contained in:
parent
dd4d016de8
commit
20ec2a74b8
1 changed files with 5 additions and 5 deletions
10
mpv.py
10
mpv.py
|
|
@ -1483,13 +1483,13 @@ class MPV(object):
|
|||
function decorator if no handler is given.
|
||||
|
||||
To unregister the observer, call either of ``mpv.unobserve_property(name, handler)``,
|
||||
``mpv.unobserve_all_properties(handler)`` or the handler's ``unregister_mpv_properties`` attribute::
|
||||
``mpv.unobserve_all_properties(handler)`` or the handler's ``unobserve_mpv_properties`` attribute::
|
||||
|
||||
@player.observe_property('volume')
|
||||
def my_handler(new_volume, *):
|
||||
print("It's loud!", volume)
|
||||
@player.property_observer('volume')
|
||||
def my_handler(property_name, new_volume):
|
||||
print("It's loud!", new_volume)
|
||||
|
||||
my_handler.unregister_mpv_properties()
|
||||
my_handler.unobserve_mpv_properties()
|
||||
|
||||
exit_handler is a function taking no arguments that is called when the underlying mpv handle is terminated (e.g.
|
||||
from calling MPV.terminate() or issuing a "quit" input command).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue