note description: "A sound to be played by an audio source." author: "Louis Marchand" date: "Tue, 21 Feb 2017 00:15:23 +0000" revision: "2.1" deferred class interface AUDIO_SOUND feature -- Access generating_type: TYPE [detachable AUDIO_SOUND] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty has_error: BOOLEAN -- Is the library has generate an error -- (from GAME_ERROR_MANAGER) has_ressource_error: BOOLEAN -- Has an error occured while opening Current -- (from GAME_RESSOURCE) is_open: BOOLEAN -- Is Current has been properly opened -- (from GAME_RESSOURCE) is_openable: BOOLEAN -- Can Current be open -- (from GAME_RESSOURCE) last_error: READABLE_STRING_GENERAL -- The last error generate by the library -- (from GAME_ERROR_MANAGER) open -- Open Current -- (from GAME_RESSOURCE) require -- from GAME_RESSOURCE ressource_is_openable: is_openable ressource_is_not_open: not is_open and not has_ressource_error ensure -- from GAME_RESSOURCE ressource_is_open: is_open or has_ressource_error feature --Access bits_per_sample: INTEGER_32 -- Get the bit resolution of one frame of Current. require sound_is_open: is_open channel_count: INTEGER_32 -- Get the channel number of Current (1=mono, 2=stereo, etc.). require sound_is_open: is_open close -- Stop the management of the stream require sound_is_open: is_open ensure sound_is_closed: not is_open frequency: INTEGER_32 -- Get the frequency (sample rate) of Current. require sound_is_open: is_open is_finished: BOOLEAN -- Current has finished it's playback is_seekable: BOOLEAN -- Return true if Current support the seek functionnality. require sound_is_open: is_open is_signed: BOOLEAN -- True if the frames in the buffer are signed. require sound_is_open: is_open restart -- Restart Current to the beginning. require sound_is_open: is_open sample_count: INTEGER_64 -- The total number of frames in Current require sound_is_open: is_open is_seekable: is_seekable sample_position: INTEGER_64 -- The number of frames since the beginning of Current require sound_is_open: is_open is_seekable: is_seekable sample_seek (a_frame_number: INTEGER_64) -- Seek at the frame a_frame_number from the beginning of Current require sound_is_open: is_open is_seekable: is_seekable is_seek_inside: a_frame_number >= 1 and a_frame_number <= sample_count time_count: INTEGER_64 -- The total number of milliseconds in Current require sound_is_open: is_open is_seekable: is_seekable time_position: INTEGER_64 -- The number of milliseconds since the beginning of Current require sound_is_open: is_open is_seekable: is_seekable time_seek (a_milliseconds: INTEGER_64) -- Seek at a_milliseconds from the beginning of Current require sound_is_open: is_open is_seekable: is_seekable is_seek_inside: a_milliseconds >= 1 and a_milliseconds <= time_count feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: AUDIO_SOUND): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: AUDIO_SOUND): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: AUDIO_SOUND): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Duplication copy (other: AUDIO_SOUND) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: AUDIO_SOUND) -- Effect equivalent to that of: -- copy (other . deep_twin) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: AUDIO_SOUND -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: AUDIO_SOUND) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: AUDIO_SOUND -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: AUDIO_SOUND -- New object equal to Current -- twin calls copy; to change copying/twinning semantics, redefine copy. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable AUDIO_SOUND -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.default for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void invariant errors_valid: has_error ~ has_ressource_error -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) end -- class AUDIO_SOUND
Generated by ISE EiffelStudio