Class: Deftones::Event::ToneEvent

Inherits:
Object
  • Object
show all
Includes:
CallbackBehavior
Defined in:
lib/deftones/event/tone_event.rb

Instance Attribute Summary collapse

Attributes included from CallbackBehavior

#humanize, #mute, #playback_rate, #state

Instance Method Summary collapse

Methods included from CallbackBehavior

#callback_interval, #callback_permitted?, #callback_time, #humanized_time, #initialize_callback_behavior, #mark_started, #mark_stopped, #mute?, #playbackRate=

Constructor Details

#initialize(transport: Deftones.transport, probability: 1.0, loop: false, loop_start: 0.0, loop_end: nil, humanize: false, mute: false, playback_rate: 1.0, seed: nil, rng: nil, &callback) ⇒ ToneEvent

Returns a new instance of ToneEvent.

Raises:

  • (ArgumentError) 


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/deftones/event/tone_event.rb', line 10

def initialize(transport: Deftones.transport, probability: 1.0, loop: false,
               loop_start: 0.0, loop_end: nil, humanize: false, mute: false, playback_rate: 1.0,
               seed: nil, rng: nil, &callback)
  raise ArgumentError, "callback is required" unless callback

  @transport = transport
  @callback = callback
  @loop = loop
  @loop_start = loop_start
  @loop_end = loop_end
  @event_id = nil
  initialize_callback_behavior(
    probability: probability,
    humanize: humanize,
    mute: mute,
    playback_rate: playback_rate,
    seed: seed,
    rng: rng
  )
end

Instance Attribute Details

#loop ⇒ Object

Returns the value of attribute loop.



8
9
10
 
# File 'lib/deftones/event/tone_event.rb', line 8

def loop
  @loop
end

#loop_end ⇒ Object Also known as: loopEnd

Returns the value of attribute loop_end.



8
9
10
 
# File 'lib/deftones/event/tone_event.rb', line 8

def loop_end
  @loop_end
end

#loop_start ⇒ Object Also known as: loopStart

Returns the value of attribute loop_start.



8
9
10
 
# File 'lib/deftones/event/tone_event.rb', line 8

def loop_start
  @loop_start
end

#probability ⇒ Object

Returns the value of attribute probability.



8
9
10
 
# File 'lib/deftones/event/tone_event.rb', line 8

def probability
  @probability
end

Instance Method Details

#cancel ⇒ Object 



53
54
55
56
57
58
 
# File 'lib/deftones/event/tone_event.rb', line 53

def cancel
  @transport.cancel(event_id: @event_id) if @event_id
  @event_id = nil
  mark_stopped
  self
end

#dispose ⇒ Object 



60
61
62
 
# File 'lib/deftones/event/tone_event.rb', line 60

def dispose
  cancel
end

#loopEnd=(value) ⇒ Object 



71
72
73
 
# File 'lib/deftones/event/tone_event.rb', line 71

def loopEnd=(value)
  self.loop_end = value
end

#loopStart=(value) ⇒ Object 



67
68
69
 
# File 'lib/deftones/event/tone_event.rb', line 67

def loopStart=(value)
  self.loop_start = value
end

#resolve_time(value) ⇒ Object (private) 



77
78
79
 
# File 'lib/deftones/event/tone_event.rb', line 77

def resolve_time(value)
  Deftones::Music::Time.parse(value)
end

#start(time = 0) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/deftones/event/tone_event.rb', line 31

def start(time = 0)
  start_time = resolve_time(time)

  @event_id =
    if @loop && @loop_end
      interval = callback_interval(resolve_time(@loop_end) - resolve_time(@loop_start))
      @transport.schedule_repeat(interval, start_time: start_time + resolve_time(@loop_start)) do |scheduled_time|
        @callback.call(humanized_time(scheduled_time)) if callback_permitted?
      end
    else
      @transport.schedule(start_time) do |scheduled_time|
        @callback.call(humanized_time(scheduled_time)) if callback_permitted?
      end
    end
  mark_started
  self
end

#stop(_time = nil) ⇒ Object 



49
50
51
 
# File 'lib/deftones/event/tone_event.rb', line 49

def stop(_time = nil)
  cancel
end