Class: MultimediaParadise::Audio::PlayAllAudioFiles

Inherits:
MultimediaParadise::AudioBase show all
Defined in:
lib/multimedia_paradise/audio/play_all_audio_files.rb

Overview

MultimediaParadise::Audio::PlayAllAudioFiles

Constant Summary collapse

IGNORE_FILES_THAT_HAVE_THE_SUBSTRING_DONE =
#

IGNORE_FILES_THAT_HAVE_THE_SUBSTRING_DONE

#
true

Constants inherited from Base

Base::ERROR, Base::ERROR_LINE, Base::NAMESPACE, Base::USE_THIS_NAMESPACE_FOR_THE_COLOURS, Base::USE_THIS_NAMESPACE_FOR_THE_CORE_COLOURS

Instance Method Summary collapse

Methods inherited from MultimediaParadise::AudioBase

#directory_to_the_local_songs?, #return_random_audio_file

Methods inherited from Base

[], #actions, #append_what_into, #be_silent, #be_verbose?, #beautiful_url, #cartoons_directory?, #clear_the_internal_hash, #cliner, #cliner_with_time_stamp, #colourized_comment, #copy_file, #crimson, #dataset_from_file_video_collection, #dd_mm_yyyy, #debug?, #default_readlines, #directory_to_realvids?, #do_not_use_opn, #dodgerblue, #does_the_video_player_support_this_commandline?, #e, #ecomment, #ecrimson, #efancy, #enable_debug, #ensure_main_encoding, #ensure_that_the_output_directory_exists, #eparse, #erev, #esystem, #ewarn, #file_video_collection?, #filter_for_audio_files, #filter_for_video_files, #forestgreen, #gold, #grey, #hh_mm_ss, #home_x_video?, #indianred, #infer_the_namespace, #internal_hash?, #is_audio_file?, #is_mkv?, #is_mp3?, #is_mp4?, #is_multimedia_file?, #is_on_roebe?, #is_video_file?, #konsole_colour_peru, #lightblue, #lightgreen, #load_yaml, #local_audio_directory?, #log_dir?, #map_symbol_to_locally_existing_file, #mediumorchid, #mediumpurple, #mediumslateblue, #mkdir, #move_file, #namespace?, #no_file_exists, #no_file_exists_at, #olive, #olivedrab, #opne, #opnecomment, #opnn, #orange, #palegoldenrod, #palegreen, #powderblue, #project_base_directory?, #rds, #register_sigint, #remove_file, #report_pwd, #reset_the_internal_hash, #return_all_video_files, #return_pwd, #return_random_video, #rev, #royalblue, #save_what_into, #sdir, #seagreen, #seconds_to_time_format, #select_only_video_files_from, #set_be_verbose, #set_use_colours, #sfancy, #sfile, #simp, #skyblue, #slateblue, #springgreen, #steelblue, #swarn, #teal, #time_right_now, #to_hh_mm_ss, #tomato, #true_rev, #try_to_rename_kde_konsole_tab, #ucliner, #use_colours?, #use_opn?, #use_which_video_player?, #verbose_truth, #video_collection?, #violet, #yaml_directory?, #yel

Methods included from CommandlineArgumentsModule

#all_input_starts_with_a_number?, #commandline_arguments?, #commandline_arguments_as_a_string, #first_argument?, #first_non_hyphened_commandline_argument?, #set_commandline_arguments

Constructor Details

#initialize(from_this_directory = return_pwd, run_already = true) ⇒ PlayAllAudioFiles

#

initialize

The first argument is the directory from which we will obtain the audio files from.s

#


34
35
36
37
38
39
40
41
42
43
 
# File 'lib/multimedia_paradise/audio/play_all_audio_files.rb', line 34

def initialize(
    from_this_directory = return_pwd,
    run_already         = true
  )
  reset
  set_this_directory(
    from_this_directory
  )
  run if run_already
end

Instance Method Details

#obtain_all_audio_files(from_this_directory = '*') ⇒ Object

#

obtain_all_audio_files

#


82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/multimedia_paradise/audio/play_all_audio_files.rb', line 82

def obtain_all_audio_files(
    from_this_directory = '*'
  )
  @audio_files = Dir[from_this_directory].select {|file|
    is_audio_file?(file)
  }
  if IGNORE_FILES_THAT_HAVE_THE_SUBSTRING_DONE # Ignore files with the "DONE_" substring.
    @audio_files.reject! {|file|
      file.include? 'DONE_' 
    }
  end
end

#play_audio_files ⇒ Object

#

play_audio_files

Use this method to play the audio files.

#


116
117
118
119
120
121
122
123
 
# File 'lib/multimedia_paradise/audio/play_all_audio_files.rb', line 116

def play_audio_files
  @audio_files.each {|file|
    e
    e sfile(file)
    e
    play_this_audio_file(file)
  }
end

#play_this_audio_file(this_file) ⇒ Object

#

play_this_audio_file

#


105
106
107
108
109
 
# File 'lib/multimedia_paradise/audio/play_all_audio_files.rb', line 105

def play_this_audio_file(this_file)
  use_this_command = "#{use_which_audio_player?} #{this_file}"
  cliner { e olivedrab(use_this_command) }
  system use_this_command
end

#reset ⇒ Object

#

reset

#


48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/multimedia_paradise/audio/play_all_audio_files.rb', line 48

def reset
  super()
  # ======================================================================= #
  # === @audio_files
  # ======================================================================= #
  @audio_files = nil
  # ======================================================================= #
  # === :use_colours
  # ======================================================================= #
  set_use_colours
end

#run ⇒ Object

#

run (run tag)

#


128
129
130
131
132
 
# File 'lib/multimedia_paradise/audio/play_all_audio_files.rb', line 128

def run
  obtain_all_audio_files
  shuffle_audio_files
  play_audio_files
end

#set_this_directory(i = :default) ⇒ Object

#

set_this_directory

#


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/multimedia_paradise/audio/play_all_audio_files.rb', line 63

def set_this_directory(
    i = :default
  )
  i = i.first if i.is_a? Array
  case i
  # ======================================================================= #
  # === :default
  # ======================================================================= #
  when :default,
       nil
    i = return_pwd
  end
  i << '/' unless i.end_with? '/'
  @this_directory = i
end

#shuffle_audio_files ⇒ Object

#

shuffle_audio_files

#


98
99
100
 
# File 'lib/multimedia_paradise/audio/play_all_audio_files.rb', line 98

def shuffle_audio_files
  @audio_files.shuffle!
end